Profiles
Esta página no está disponible en español. Se muestra la versión en inglés.
Get Profiles
Authorization
appToken readAuthorizationBearer <token>
App access token issued by POST /tokens (client credentials). Full-access Apps hold the read and write scopes, read-only Apps hold read only. Send it as Authorization: Bearer <token>.
In: header
Scope: read
Query Parameters
limit?integer
Default
20offset?integer
Default
0filter[uuid]?string
Exact match on the profile uuid (the B2Core client ID).
filter[enabled]?integer
1 returns enabled profiles, 0 returns disabled ones.
Value in
- 0
- 1
filter[name]?string
Case-insensitive substring match on the full name.
filter[firstName]?string
Case-insensitive substring match on the first name.
filter[lastName]?string
Case-insensitive substring match on the last name.
filter[middleName]?string
Case-insensitive substring match on the middle name.
sort_by?string
Sort column. Without it, profiles are ordered by profileId. Ties are always broken by profileId.
Value in
- "createTime"
- "updateTime"
- "profileId"
- "enabled"
- "name"
- "firstName"
- "lastName"
- "middleName"
sort_order?string
Sort direction (default asc)
Value in
- "asc"
- "desc"
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/profiles"{ "total": 0, "profiles": [ { "profileId": "string", "firstName": "string", "lastName": "string", "middleName": "string", "countryNumericCode": "string", "enabled": true, "contacts": [ { "contactId": "string", "key": "email", "value": "string", "createTime": "2019-08-24T14:15:22Z", "updateTime": "2019-08-24T14:15:22Z", "uuid": "string" } ], "createTime": "2019-08-24T14:15:22Z", "updateTime": "2019-08-24T14:15:22Z", "uuid": "string" } ]}{ "message": "string", "code": "string", "errors": { "property1": [ "string" ], "property2": [ "string" ] }, "details": [ { "field": "string", "issue": "string" } ]}{ "message": "string", "code": "string", "errors": { "property1": [ "string" ], "property2": [ "string" ] }, "details": [ { "field": "string", "issue": "string" } ]}{ "message": "string", "code": "string", "errors": { "property1": [ "string" ], "property2": [ "string" ] }, "details": [ { "field": "string", "issue": "string" } ]}