Get a list of custom attributes

Get a list of custom attributes using this method.

Please log in to see full path URL. Learn why.

get

/people/2/customAttributes

Authorizations:

Scopes:

people:manage

people:read

Request rate limit:

5 requests / second (per account)

Learn more

query Parameters

limit	integer <int32> Example: limit=100 Number of custom attributes to return per page. Default - 20. Maximum - 1000.
page	integer <int32> Example: page=1 Page of results to return. Default - 1.
includeTotalCount	boolean Example: includeTotalCount=false Returns total count of custom attributes, if set to `true`.
orderBy	string Example: orderBy=name:asc Results ordering. Possible ordering fields are `name`, `createdAt` and `modifiedAt`. Ordering direction can be specified with modifiers `asc` for the ascending ordering or `desc` for the descending one.

Responses

default

successful response

401

Unauthorized

403

Forbidden

429

Too Many Requests

4XX

Error responses

500

Internal Server Error

5XX

Error responses

Request samples

Example

cURL

Copy

curl -L -g 'https://{baseUrl}/people/2/customAttributes?limit=100&page=1&includeTotalCount=false&orderBy=name%3Aasc' \
-H 'Authorization: {authorization}' \
-H 'Accept: application/json'

Response samples

Content type

Copy

Collapse all


{"limit": 100,
"page": 1,
"orderBy": "name:asc",
"customAttributes": 
[
{"createdAt": "2019-02-25T12:46:06",
"modifiedAt": "2019-02-25T12:46:06",
"name": "Contract Expiry Date",
"dataType": "DATE"
},
{"createdAt": "2019-02-25T12:46:06",
"modifiedAt": "2019-02-25T12:46:06",
"name": "ShoppingCartList",
"dataType": "LIST_OF_OBJECTS",
"objectSchema": 
{"productName": "STRING",
"productPrice": "DECIMAL",
"productCategory": "STRING",
"productImage": "STRING"
}
}
]
}

Need assistance

Explore Infobip Tutorials

Encountering issues

Contact our support

What's new? Check out

Release Notes

Unsure about a term? See

Glossary

Research panel

Help shape the future of our products

Learn more

Service status

Privacy documents Terms of use