These are the API docs for the Expansive Integrations API.
\nUsing this API will allow you and your team to smoothly integrate Expansive into your workflow.
\nThese docs are organised by resources - you can find all the details you need to manage a given resource in the relevant collection.
\nThis documentation if for version 3.50.0 of the application
\nWe're here to help
\nIf you can't find what you're looking for or need more help then drop us a message: api@expansive.co.uk
\nThe API is built to the json:api standard. We recommend you check out their docs for detailed information and useful resources including implementations in most languages.
\nAccess to all resources on the API are protected. You must use valid credentials to authenticate before accessing any resources. Your account manager can provide these credentials. All credentials should be considered sesnitive and treated as such.
\nYour account has two environments for use in any integration:
\nUAT - a sandbox for all development and testing
\nPRO - for production ready integrations. This is against live data.
\nThese environments are on separate domains. These details will be provided by your account manager
\nTo get the most out of the Expansive API it is common to chain a number of requests together. For example: To create a new user you might:
\nGet a Site ID the user will be responsible for
\nGet the Role you want the user to belong to
\nCreate the User (using the Site and Role)
\nIf there is a scenario you'd like to build and you're not sure how to order the requests then we'd happy to help - just talk to your account manager to get the conversation started.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"31357785","collectionId":"0beae54a-ccee-439b-96df-9c852ddd4426","publishedId":"2sB3QMN9xx","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-10-14T14:21:27.000Z"},"item":[{"name":"Authentication","item":[{"name":"create-access-token","event":[{"listen":"test","script":{"exec":["let response = pm.response.json();","","pm.collectionVariables.set(\"token\", response.data.token);"],"type":"text/javascript","packages":[],"id":"2d42699d-7402-4ec3-b1a3-bb0564f404e4"}}],"id":"c963cd21-2313-4175-8e84-a771d6ffe3f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/api/access_token","description":"This endpoint creates a new access token for user authentication.
\nMethod: POST
\nURL: /api/access_token
\nHeaders:
\nAuthorization: None
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
The request body should be in JSON format and include the following parameters:
\nemail
required
\nstring
\npassword
required
\nstring
\nname
required
\nstring
\nExample request body:
\n{\n \"email\": string,\n \"password\": string,\n \"name\": string\n}\n\nStatus: 201 Created
\nReturns: A JSON object containing the created access token, user ID, and a flag indicating if a password change is required.
\n{\n \"data\": {\n \"token\": string, \n \"user_id\": integer,\n \"force_password_change\": boolean\n }\n}\n\nThis endpoint deletes the current access token.
\nMethod: DELETE
\nURL: /api/access_token
\nHeaders:
\nAuthorization: Bearer
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
There is no request body required for this endpoint.
\nStatus: 204 No Content
\nReturns: The access token was successfully deleted. No body is returned.
\nRetrieves a list of budget-types.
\n","urlObject":{"path":["api","integrations","budget-types"],"host":[""],"query":[{"description":{"content":"Number of resources per page
\n","type":"text/plain"},"key":"page[size]","value":"50"},{"description":{"content":"The page number to retrieve
\n","type":"text/plain"},"key":"page[number]","value":"1"}],"variable":[]}},"response":[{"id":"16eae768-72a5-4872-acbd-7eead34989f7","name":"example","originalRequest":{"auth":{"type":"bearer","bearer":{"token":""}},"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":{"raw":"/api/integrations/budget-types?page[size]=50&page[number]=1","host":[""],"path":["api","integrations","budget-types"],"query":[{"key":"page[size]","value":"50","description":"Number of resources per page"},{"key":"page[number]","value":"1","description":"The page number to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"page\": {\n \"currentPage\": \"Retrieves an individual budget-type resource by it's ID.
\n","urlObject":{"path":["api","integrations","budget-types","{budget_type}"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"dbde55ac-88e9-44ec-94c0-b6b883a76758","name":"example","originalRequest":{"auth":{"type":"bearer","bearer":{"token":""}},"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"/api/integrations/budget-types/{budget_type}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"links\": {\n \"self\": \"/api/integrations/budget-types/{budget_type}/This section documents the budget-types resource.
\nThe following endpoints are available for interacting with this resource:
\nThe following attributes are available for this resource:
\nid: identifierenabled: booleanname: stringThese attributes are returned for every budget-type resource. You can restrict the attributes returned in the response by using the fields query parameter to specify one or more attributes.
curl --location --request GET '/api/budget-types?fields[budget-types]=attribute_key1,attribute_key2'\n--header 'Accept: application/vnd.api+json'\n--header 'Authorization: Bearer '\nThere are no relationships available for this resource.
\nThe following filters are available for this resource:
\nname: accepts a string value and partially matchesenabled: accepts a boolean value and strictly matchesFilters can be used to narrow down the results returned by the API for GET requests. Use the filter query parameter to specify one or more filters.
curl --location --request GET '/api/budget-types?filter[<filter_key_1>]=<value>&filter[<filter_key_2>]=<value>'\n--header 'Accept: application/vnd.api+json'\n--header 'Authorization: Bearer '\nThere are no sortable available for this resource.
\n","_postman_id":"74822afc-1919-4b13-a2b6-0e4673621baf"},{"name":"budgets","item":[{"name":"index","id":"ffe892b6-55df-4956-ae95-a49c7c6a3c28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"/api/integrations/budgets?page[size]=50&page[number]=1","description":"Retrieves a list of budgets.
\n","urlObject":{"path":["api","integrations","budgets"],"host":[""],"query":[{"description":{"content":"Number of resources per page
\n","type":"text/plain"},"key":"page[size]","value":"50"},{"description":{"content":"The page number to retrieve
\n","type":"text/plain"},"key":"page[number]","value":"1"}],"variable":[]}},"response":[{"id":"15fa2e76-e0bb-4cb0-90e7-2f36aa66f8e2","name":"example","originalRequest":{"auth":{"type":"bearer","bearer":{"token":""}},"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":{"raw":"/api/integrations/budgets?page[size]=50&page[number]=1","host":[""],"path":["api","integrations","budgets"],"query":[{"key":"page[size]","value":"50","description":"Number of resources per page"},{"key":"page[number]","value":"1","description":"The page number to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"page\": {\n \"currentPage\": \"Retrieves an individual budget resource by it's ID.
\n","urlObject":{"path":["api","integrations","budgets","{budget}"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"7b7601b2-93b8-419e-a448-b7635ac00539","name":"example","originalRequest":{"auth":{"type":"bearer","bearer":{"token":""}},"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"/api/integrations/budgets/{budget}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"links\": {\n \"self\": \"/api/integrations/budgets/{budget}/This section documents the budgets resource.
\nThe following endpoints are available for interacting with this resource:
\nThe following attributes are available for this resource:
\nid: identifiername: stringselectable: booleanThese attributes are returned for every budget resource. You can restrict the attributes returned in the response by using the fields query parameter to specify one or more attributes.
curl --location --request GET '/api/budgets?fields[budgets]=attribute_key1,attribute_key2'\n--header 'Accept: application/vnd.api+json'\n--header 'Authorization: Bearer '\nThe following relationships are available for this resource:
\nbudgetType: to oneRelationships can be used to include related resources in the response. Use the include query parameter to specify which relationships to include.
curl --location --request GET '/api/budgets?include=<relationship_key1>,<relationship_key2>'\n--header 'Accept: application/vnd.api+json'\n--header 'Authorization: Bearer '\nThe following filters are available for this resource:
\nname: accepts a string value and partially matchesselectable: accepts a boolean value and strictly matchesFilters can be used to narrow down the results returned by the API for GET requests. Use the filter query parameter to specify one or more filters.
curl --location --request GET '/api/budgets?filter[<filter_key_1>]=<value>&filter[<filter_key_2>]=<value>'\n--header 'Accept: application/vnd.api+json'\n--header 'Authorization: Bearer '\nThere are no sortable available for this resource.
\n","_postman_id":"400247de-eac5-492a-987b-04ab506e3ed1"},{"name":"contractors","item":[{"name":"index","id":"4e93512f-2d93-4222-9551-23a994253bd9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"/api/integrations/contractors?page[size]=50&page[number]=1","description":"Retrieves a list of contractors.
\n","urlObject":{"path":["api","integrations","contractors"],"host":[""],"query":[{"description":{"content":"Number of resources per page
\n","type":"text/plain"},"key":"page[size]","value":"50"},{"description":{"content":"The page number to retrieve
\n","type":"text/plain"},"key":"page[number]","value":"1"}],"variable":[]}},"response":[{"id":"d0dc14ce-b1e5-4b96-a75f-9933098c3418","name":"example","originalRequest":{"auth":{"type":"bearer","bearer":{"token":""}},"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":{"raw":"/api/integrations/contractors?page[size]=50&page[number]=1","host":[""],"path":["api","integrations","contractors"],"query":[{"key":"page[size]","value":"50","description":"Number of resources per page"},{"key":"page[number]","value":"1","description":"The page number to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"page\": {\n \"currentPage\": \"Retrieves an individual contractor resource by it's ID.
\n","urlObject":{"path":["api","integrations","contractors","{contractor}"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"5d6f175d-02b1-41ba-a057-b7e6a7c47991","name":"example","originalRequest":{"auth":{"type":"bearer","bearer":{"token":""}},"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"/api/integrations/contractors/{contractor}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"links\": {\n \"self\": \"/api/integrations/contractors/{contractor}/This section documents the contractors resource.
\nThe following endpoints are available for interacting with this resource:
\nThe following attributes are available for this resource:
\nid: identifiername: stringexternal_id: stringenabled: booleanThese attributes are returned for every contractor resource. You can restrict the attributes returned in the response by using the fields query parameter to specify one or more attributes.
curl --location --request GET '/api/contractors?fields[contractors]=attribute_key1,attribute_key2'\n--header 'Accept: application/vnd.api+json'\n--header 'Authorization: Bearer '\nThere are no relationships available for this resource.
\nThe following filters are available for this resource:
\nname: accepts a string value and partially matchesexternal_id: accepts a string value and strictly matchesenabled: accepts a boolean value and strictly matchesFilters can be used to narrow down the results returned by the API for GET requests. Use the filter query parameter to specify one or more filters.
curl --location --request GET '/api/contractors?filter[<filter_key_1>]=<value>&filter[<filter_key_2>]=<value>'\n--header 'Accept: application/vnd.api+json'\n--header 'Authorization: Bearer '\nThere are no sortable available for this resource.
\n","_postman_id":"5f820eb4-876e-45d8-bfde-cbbc6b01b380"},{"name":"cost-codes","item":[{"name":"index","id":"248e325e-55f3-434e-beed-2c628a81a297","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"/api/integrations/cost-codes?page[size]=50&page[number]=1","description":"Retrieves a list of cost-codes.
\n","urlObject":{"path":["api","integrations","cost-codes"],"host":[""],"query":[{"description":{"content":"Number of resources per page
\n","type":"text/plain"},"key":"page[size]","value":"50"},{"description":{"content":"The page number to retrieve
\n","type":"text/plain"},"key":"page[number]","value":"1"}],"variable":[]}},"response":[{"id":"ad879de0-2bc4-48aa-99e3-54d47ea47e4a","name":"example","originalRequest":{"auth":{"type":"bearer","bearer":{"token":""}},"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":{"raw":"/api/integrations/cost-codes?page[size]=50&page[number]=1","host":[""],"path":["api","integrations","cost-codes"],"query":[{"key":"page[size]","value":"50","description":"Number of resources per page"},{"key":"page[number]","value":"1","description":"The page number to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"page\": {\n \"currentPage\": \"Retrieves an individual cost-code resource by it's ID.
\n","urlObject":{"path":["api","integrations","cost-codes","{cost_code}"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"45350265-a08a-4f31-bd3a-42dd1ec19d9a","name":"example","originalRequest":{"auth":{"type":"bearer","bearer":{"token":""}},"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"/api/integrations/cost-codes/{cost_code}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"links\": {\n \"self\": \"/api/integrations/cost-codes/{cost_code}/Creates a new cost-code resource.
\nEach item in the data.attributes object should comply with the following:
name: required, string, must be uniquecode: required, string, must be uniquedescription: optional, nullable, stringenabled: optional, nullable, booleanrestrict_spend_authorization: optional, nullable, booleanEach item in the data.relationships object should comply with the following:
costType: required, to-one relationship, must be selectablecost-typesauthorizedRoles: optional, to-many relationship, must be enabled, must be empty when restrict spend authorization is false.rolesauthorizedUsers: optional, to-many relationship, must be enabled, must be empty when restrict spend authorisation is false.rolesUpdates an existing cost-code resource by it's ID.
\nEach item in the data.attributes object should comply with the following:
name: required, string, must be uniquecode: required, string, must be uniquedescription: optional, nullable, stringenabled: optional, nullable, booleanrestrict_spend_authorization: optional, nullable, booleanEach item in the data.relationships object should comply with the following:
costType: required, to-one relationship, must be selectablecost-typesauthorizedRoles: optional, to-many relationship, must be enabled, must be empty when restrict spend authorization is false.rolesauthorizedUsers: optional, to-many relationship, must be enabled, must be empty when restrict spend authorisation is false.rolesDeletes an existing cost-code resource by it's ID.
\n","urlObject":{"path":["api","integrations","cost-codes","{cost_code}"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"4c481ba8-c514-4314-b34c-8e007b1d62ad","name":"example","originalRequest":{"auth":{"type":"bearer","bearer":{"token":""}},"method":"DELETE","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"/api/integrations/cost-codes/{cost_code}"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c3025445-fa8e-4790-b11f-c8aec6323251"}],"id":"026e9dea-d732-49cb-b8e8-b59c6019586b","description":"This section documents the cost-codes resource.
\nThe following endpoints are available for interacting with this resource:
\nThe following attributes are available for this resource:
\nid: identifiername: stringcode: stringdescription: stringenabled: booleanrestrict_spend_authorization: booleanThese attributes are returned for every cost-code resource. You can restrict the attributes returned in the response by using the fields query parameter to specify one or more attributes.
curl --location --request GET '/api/cost-codes?fields[cost-codes]=attribute_key1,attribute_key2'\n--header 'Accept: application/vnd.api+json'\n--header 'Authorization: Bearer '\nThe following relationships are available for this resource:
\ncostType: to oneauthorizedRoles: to manyauthorizedUsers: to manyRelationships can be used to include related resources in the response. Use the include query parameter to specify which relationships to include.
curl --location --request GET '/api/cost-codes?include=<relationship_key1>,<relationship_key2>'\n--header 'Accept: application/vnd.api+json'\n--header 'Authorization: Bearer '\nThe following filters are available for this resource:
\nname: accepts a string value and partially matchescode: accepts a string value and partially matchesenabled: accepts a boolean value and strictly matchescostType.id: accepts an integer value to filter by the cost type IDFilters can be used to narrow down the results returned by the API for GET requests. Use the filter query parameter to specify one or more filters.
curl --location --request GET '/api/cost-codes?filter[<filter_key_1>]=<value>&filter[<filter_key_2>]=<value>'\n--header 'Accept: application/vnd.api+json'\n--header 'Authorization: Bearer '\nThere are no sortable available for this resource.
\n","_postman_id":"026e9dea-d732-49cb-b8e8-b59c6019586b"},{"name":"cost-types","item":[{"name":"index","id":"4764c6fb-3d4e-4eb9-8e3e-7bafd5c6c2d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"/api/integrations/cost-types?page[size]=50&page[number]=1","description":"Retrieves a list of cost-types.
\n","urlObject":{"path":["api","integrations","cost-types"],"host":[""],"query":[{"description":{"content":"Number of resources per page
\n","type":"text/plain"},"key":"page[size]","value":"50"},{"description":{"content":"The page number to retrieve
\n","type":"text/plain"},"key":"page[number]","value":"1"}],"variable":[]}},"response":[{"id":"52f39dda-a79e-466c-9077-72431283385f","name":"example","originalRequest":{"auth":{"type":"bearer","bearer":{"token":""}},"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":{"raw":"/api/integrations/cost-types?page[size]=50&page[number]=1","host":[""],"path":["api","integrations","cost-types"],"query":[{"key":"page[size]","value":"50","description":"Number of resources per page"},{"key":"page[number]","value":"1","description":"The page number to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"page\": {\n \"currentPage\": \"Retrieves an individual cost-type resource by it's ID.
\n","urlObject":{"path":["api","integrations","cost-types","{cost_type}"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"5b170203-6afc-43a8-85eb-2ee2ab92ea4d","name":"example","originalRequest":{"auth":{"type":"bearer","bearer":{"token":""}},"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"/api/integrations/cost-types/{cost_type}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"links\": {\n \"self\": \"/api/integrations/cost-types/{cost_type}/This section documents the cost-types resource.
\nThe following endpoints are available for interacting with this resource:
\nThe following attributes are available for this resource:
\nid: identifiername: stringcode: stringselectable: booleanThese attributes are returned for every cost-type resource. You can restrict the attributes returned in the response by using the fields query parameter to specify one or more attributes.
curl --location --request GET '/api/cost-types?fields[cost-types]=attribute_key1,attribute_key2'\n--header 'Accept: application/vnd.api+json'\n--header 'Authorization: Bearer '\nThere are no relationships available for this resource.
\nThe following filters are available for this resource:
\nname: accepts a string value and partially matchescode: accepts a string value and partially matchesselectable: accepts a boolean value and strictly matchesFilters can be used to narrow down the results returned by the API for GET requests. Use the filter query parameter to specify one or more filters.
curl --location --request GET '/api/cost-types?filter[<filter_key_1>]=<value>&filter[<filter_key_2>]=<value>'\n--header 'Accept: application/vnd.api+json'\n--header 'Authorization: Bearer '\nThere are no sortable available for this resource.
\n","_postman_id":"11e681b5-0201-49d1-9831-fdf3c3d124a0"},{"name":"countries","item":[{"name":"index","id":"84e2f82d-e080-4949-b2fe-f47efee2909f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"/api/integrations/countries?page[size]=50&page[number]=1","description":"Retrieves a list of countries.
\n","urlObject":{"path":["api","integrations","countries"],"host":[""],"query":[{"description":{"content":"Number of resources per page
\n","type":"text/plain"},"key":"page[size]","value":"50"},{"description":{"content":"The page number to retrieve
\n","type":"text/plain"},"key":"page[number]","value":"1"}],"variable":[]}},"response":[{"id":"521a7849-e758-4e76-91f0-9db50cebb657","name":"example","originalRequest":{"auth":{"type":"bearer","bearer":{"token":""}},"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":{"raw":"/api/integrations/countries?page[size]=50&page[number]=1","host":[""],"path":["api","integrations","countries"],"query":[{"key":"page[size]","value":"50","description":"Number of resources per page"},{"key":"page[number]","value":"1","description":"The page number to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"page\": {\n \"currentPage\": \"Retrieves an individual country resource by it's ID.
\n","urlObject":{"path":["api","integrations","countries","{country}"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"f37a0587-4378-4ca6-b60f-56715ea464d7","name":"example","originalRequest":{"auth":{"type":"bearer","bearer":{"token":""}},"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"/api/integrations/countries/{country}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"links\": {\n \"self\": \"/api/integrations/countries/{country}/This section documents the countries resource.
\nThe following endpoints are available for interacting with this resource:
\nThe following attributes are available for this resource:
\nid: identifiername: stringselectable: booleanThese attributes are returned for every country resource. You can restrict the attributes returned in the response by using the fields query parameter to specify one or more attributes.
curl --location --request GET '/api/countries?fields[countries]=attribute_key1,attribute_key2'\n--header 'Accept: application/vnd.api+json'\n--header 'Authorization: Bearer '\nThe following relationships are available for this resource:
\ndefaultTaxRate: to oneRelationships can be used to include related resources in the response. Use the include query parameter to specify which relationships to include.
curl --location --request GET '/api/countries?include=<relationship_key1>,<relationship_key2>'\n--header 'Accept: application/vnd.api+json'\n--header 'Authorization: Bearer '\nThe following filters are available for this resource:
\nname: accepts a string value and partially matchesselectable: accepts a boolean value and strictly matchesdefaultTaxRate.id: accepts an integer value to filter by the default tax rate IDFilters can be used to narrow down the results returned by the API for GET requests. Use the filter query parameter to specify one or more filters.
curl --location --request GET '/api/countries?filter[<filter_key_1>]=<value>&filter[<filter_key_2>]=<value>'\n--header 'Accept: application/vnd.api+json'\n--header 'Authorization: Bearer '\nThere are no sortable available for this resource.
\n","_postman_id":"2c9846cc-8be7-41b1-af1f-bfe3f54e3254"},{"name":"currencies","item":[{"name":"index","id":"06ea4f74-68f6-417c-9ac2-9eca362e2511","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"/api/integrations/currencies?page[size]=50&page[number]=1","description":"Retrieves a list of currencies.
\n","urlObject":{"path":["api","integrations","currencies"],"host":[""],"query":[{"description":{"content":"Number of resources per page
\n","type":"text/plain"},"key":"page[size]","value":"50"},{"description":{"content":"The page number to retrieve
\n","type":"text/plain"},"key":"page[number]","value":"1"}],"variable":[]}},"response":[{"id":"498286f1-1831-4190-ad67-5eb69f49c04b","name":"example","originalRequest":{"auth":{"type":"bearer","bearer":{"token":""}},"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":{"raw":"/api/integrations/currencies?page[size]=50&page[number]=1","host":[""],"path":["api","integrations","currencies"],"query":[{"key":"page[size]","value":"50","description":"Number of resources per page"},{"key":"page[number]","value":"1","description":"The page number to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"page\": {\n \"currentPage\": \"Retrieves an individual currency resource by it's ID.
\n","urlObject":{"path":["api","integrations","currencies","{currency}"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"3be52a42-c0c5-49fa-abfe-aa14205c80a7","name":"example","originalRequest":{"auth":{"type":"bearer","bearer":{"token":""}},"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"/api/integrations/currencies/{currency}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"links\": {\n \"self\": \"/api/integrations/currencies/{currency}/This section documents the currencies resource.
\nThe following endpoints are available for interacting with this resource:
\nThe following attributes are available for this resource:
\nid: identifiername: stringcode: stringThese attributes are returned for every currency resource. You can restrict the attributes returned in the response by using the fields query parameter to specify one or more attributes.
curl --location --request GET '/api/currencies?fields[currencies]=attribute_key1,attribute_key2'\n--header 'Accept: application/vnd.api+json'\n--header 'Authorization: Bearer '\nThere are no relationships available for this resource.
\nThe following filters are available for this resource:
\nname: accepts a string value and partially matchescode: accepts a string value and partially matchesFilters can be used to narrow down the results returned by the API for GET requests. Use the filter query parameter to specify one or more filters.
curl --location --request GET '/api/currencies?filter[<filter_key_1>]=<value>&filter[<filter_key_2>]=<value>'\n--header 'Accept: application/vnd.api+json'\n--header 'Authorization: Bearer '\nThere are no sortable available for this resource.
\n","_postman_id":"53245983-d5fb-45fa-88ff-52b4ecb2956e"},{"name":"invoice-groups","item":[{"name":"index","id":"794f4b23-aeab-4a11-ae07-eedf4994d540","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":"/api/integrations/invoice-groups?page[size]=50&page[number]=1","description":"Retrieves a list of invoice-groups.
\n","urlObject":{"path":["api","integrations","invoice-groups"],"host":[""],"query":[{"description":{"content":"Number of resources per page
\n","type":"text/plain"},"key":"page[size]","value":"50"},{"description":{"content":"The page number to retrieve
\n","type":"text/plain"},"key":"page[number]","value":"1"}],"variable":[]}},"response":[{"id":"b7bf6f88-f754-4596-99f4-1ded49194f39","name":"example","originalRequest":{"auth":{"type":"bearer","bearer":{"token":""}},"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"url":{"raw":"/api/integrations/invoice-groups?page[size]=50&page[number]=1","host":[""],"path":["api","integrations","invoice-groups"],"query":[{"key":"page[size]","value":"50","description":"Number of resources per page"},{"key":"page[number]","value":"1","description":"The page number to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"page\": {\n \"currentPage\": \"