Users
List users
List the users belonging to the authenticated organization.
Authorization
bearerAuth AuthorizationBearer <token>
Provide an API key from the Insion dashboard in the Authorization header: Bearer YOUR_API_KEY.
In: header
Query Parameters
limit?integer
Maximum number of items to return.
Range
1 <= value <= 100Default
10starting_after?string
Return items after this Insion ID. Cannot be used with ending_before.
ending_before?string
Return items before this Insion ID. Cannot be used with starting_after.
clientId?string
Filter by your user identifier.
email?string
Filter by user email.
status?string
Filter by user action status.
Value in
- "Compliant"
- "Suspended"
- "Banned"
user?string
Filter by Insion user ID.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/users"{ "data": [ { "id": "string", "clientId": "string", "clientUrl": "http://example.com", "email": "string", "name": "string", "username": "string", "protected": true, "metadata": {}, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "actionStatus": "Compliant", "actionStatusCreatedAt": "2019-08-24T14:15:22Z", "appealUrl": "http://example.com" } ], "has_more": true}{ "error": { "message": "string" }}{ "error": { "message": "string" }}