List members

## Organization Members - List

Organization Members - List

List members with their tags and your member ids.

Paginated, 100 per page by default (page_size up to 500).

Authentication

Two ways to call these endpoints, both scoped to one organization:

  • Secret API key in the X-Flash-Api-Key header (fw_sk_...). The organization needs the Organization Locations API product. The key always acts on its own organization. Publishable keys are refused. This is the mode for software partners integrating on an organization's behalf.
  • User token (Authorization: Token ...) of an administrator of the organization.

Either way, only members of that organization can be read or changed. A user outside it is reported as not_a_member, whether or not the account exists.

GET
/organization/members/

Authorization

X-Flash-Api-Key<token>

FLASH API key. Secret keys are prefixed fw_sk_live_ and must stay server-side; publishable keys are prefixed fw_pk_live_ and are safe in a public page. Obtain via POST /api-keys/.

In: header

Query Parameters

organization_id?integer

Flash staff only, with a user token. API keys always act on their own organization.

page?integer

Page number, from 1.

page_size?integer

Results per page, up to 500. Default 100.

tag?string

Only members with this tag.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/organization/members/"
{  "count": 1,  "next": null,  "previous": null,  "results": [    {      "user_id": 311,      "email": "dana@crowther.example",      "name": "Dana Ruiz",      "is_active": true,      "is_admin": false,      "external_id": "crowther-emp-17",      "tags": [        "crew-north"      ],      "location_count": 4    }  ]}

On this page