Get details of a organization
GET {{baseUrl}}/organizations/:id?include_fields=<string>&custom_fields=<string>
Returns the details of a specific organization.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
include_fields | string | Optional comma separated string array of additional fields to include | |
custom_fields | string | Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"success":true,"data":{"id":1,"name":"Organization Name","owner_id":1,"org_id":1,"add_time":"2021-01-01T00:00:00Z","update_time":"2021-01-01T00:00:00Z","address":{"value":"123 Main St","country":"USA","admin_area_level_1":"CA","admin_area_level_2":"Santa Clara","locality":"Sunnyvale","sublocality":"Downtown","route":"Main St","street_number":"123","postal_code":"94085"},"is_deleted":false,"visible_to":7,"label_ids":[1,2,3],"custom_fields":{}}}