A company represents a customer organization, typically a business. In the Reactor API, these companies match 1:1 with organization ID. API users only have visibility into the companies to which they have access. A company may contain many properties. A property belongs to exactly one company.
The /companies
endpoint in the Reactor API allows you to programmatically retrieve the companies that you have access to within your experience application.
The endpoint used in this guide is part of the Reactor API. Before continuing, please review the getting started guide for important information regarding how to authenticate to the API.
You can list the companies that you are authorized to used by making a GET request to the /companies
endpoint. In most cases, there is exactly one.
API format
GET /companies
Using query parameters, listed companies can be filtered based on the following attributes:
created_at
name
org_id
token
updated_at
Request
curl -X GET \
https://reactor.adobe.io/companies \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H "Content-Type: application/vnd.api+json" \
-H 'Accept: application/vnd.api+json;revision=1'
Response
A successful response returns a list of companies that you have access to.
{
"data": [
{
"id": "COdb0cd64ad4524440be94b8496416ec7d",
"type": "companies",
"attributes": {
"created_at": "2020-08-13T17:13:30.667Z",
"name": "Example Company",
"org_id": "{ORG_ID}",
"updated_at": "2020-08-13T17:13:30.667Z",
"token": "d5a4f682bbae",
"cjm_enabled": false,
"edge_enabled": false,
"edge_events_allotment": null,
"edge_fanout_ratio": null
},
"relationships": {
"properties": {
"links": {
"related": "https://reactor.adobe.io/companies/COdb0cd64ad4524440be94b8496416ec7d/properties"
}
}
},
"links": {
"self": "https://reactor.adobe.io/companies/COdb0cd64ad4524440be94b8496416ec7d",
"properties": "https://reactor.adobe.io/companies/COdb0cd64ad4524440be94b8496416ec7d/properties"
},
"meta": {
"rights": [
"develop_extensions",
"manage_properties"
],
"platform_rights": {
"web": [
"develop_extensions",
"manage_properties"
],
"mobile": [
"develop_extensions",
"manage_properties"
]
}
}
}
],
"meta": {
"pagination": {
"current_page": 1,
"next_page": null,
"prev_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
You can look up a specific company by including the its ID in the path of a GET request.
API format
GET /companies/{COMPANY_ID}
Parameter | Description |
---|---|
{COMPANY_ID} |
The id value of the company you want to look up. |
Request
curl -X GET \
https://reactor.adobe.io/companies/COdb0cd64ad4524440be94b8496416ec7d \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H "Content-Type: application/vnd.api+json" \
-H 'Accept: application/vnd.api+json;revision=1'
Response
A successful response returns the details of the company.
{
"data": {
"id": "COdb0cd64ad4524440be94b8496416ec7d",
"type": "companies",
"attributes": {
"created_at": "2020-08-13T17:13:30.667Z",
"name": "Example Company",
"org_id": "{ORG_ID}",
"updated_at": "2020-08-13T17:13:30.667Z",
"token": "d5a4f682bbae",
"cjm_enabled": false,
"edge_enabled": false,
"edge_events_allotment": null,
"edge_fanout_ratio": null
},
"relationships": {
"properties": {
"links": {
"related": "https://reactor.adobe.io/companies/COdb0cd64ad4524440be94b8496416ec7d/properties"
}
}
},
"links": {
"self": "https://reactor.adobe.io/companies/COdb0cd64ad4524440be94b8496416ec7d",
"properties": "https://reactor.adobe.io/companies/COdb0cd64ad4524440be94b8496416ec7d/properties"
},
"meta": {
"rights": [
"develop_extensions",
"manage_properties"
],
"platform_rights": {
"web": [
"develop_extensions",
"manage_properties"
],
"mobile": [
"develop_extensions",
"manage_properties"
]
}
}
}
}