Company API (1.0.0)

Download OpenAPI specification:Download

Company API v1

location

Location information

Get a Location list

Get a Location list.

Responses

200

Success

get/location

Request samples

curl
JavaScript
Node.js
Python

Response samples

200

application/json

{"data": [{"id": "jX52DZVG8A0MB1b1bgrkoqwWlJpY6m",
"name": "Location 1"
},
{"id": "HgTjnbkjbuyo786590KJBKjtfdGgjy",
"name": "Location 2"
},
{"id": "awefawef3wfaw3fh445hhsdrrsUHuy",
"name": "Location 3"
}
]
}

Get a Location

Get a Location.

Request

path Parameters

location_id

required

string

The id of the location.

Responses

200

Success

get/location/{location_id}

Request samples

curl
JavaScript
Node.js
Python

Response samples

200

application/json

{"data": {"id": "jX52DZVG8A0MB1b1bgrkoqwWlJpY6m",
"name": "Location 1",
"custom_fields": [{"name": "customField2",
"title": "customField2",
"type": "input",
"isRequired": false,
"options": { },
"isShownInList": false,
"isEditable": true
},
{"name": "customField1",
"title": "customFields1",
"type": "input",
"isRequired": false,
"options": { },
"isShownInList": false,
"isEditable": true
}
]
}
}

Get a Product list

Get a Product list.

Request

path Parameters

location_id

required

string

The id of the location.

Responses

200

Success

get/location/{location_id}/product

Request samples

curl
JavaScript
Node.js
Python

Response samples

200

application/json

{"data": [{"id": "jX52DZVG8A0MB1b1bgrkoqwWlJpY6m",
"name": "Product 1"
},
{"id": "HgTjnbkjbuyo786590KJBKjtfdGgjy",
"name": "Product 2"
},
{"id": "awefawef3wfaw3fh445hhsdrrsUHuy",
"name": "Product 3"
}
]
}