> Tychron Atlas API & Provisioning Reference — chapter 26 of 35 as Markdown. Web version: https://docs.tychron.com/api-reference/csp-brands/ > Source: https://docs.tychron.com/api-reference/ · Updated 2026-08-12 · Generated from the Atlas OpenAPI spec (https://api.atlas.tychron.online/api/v1/openapi is the live contract; this file is a dated snapshot of it). > Source revision: atlas_api_reference_2026-08-12.md · sha256 482ebd3b014af053 · sanitize gate v1 clean · reconciled with OpenAPI 2026.8.25-p01 (spec sha256 cc049ef38c71cd6e) on 2026-09-05 · content last modified 2026-09-09 · newer definition under review since 2026-09-09 (not yet reconciled) > Scope: the Atlas platform API only. The SMS, MMS, CNAM, LRN and MCL services are separate APIs with their own specifications: https://docs.tychron.com/openapi/ > Machine index: https://docs.tychron.com/llms.txt # CSP Brands ## Schema A TCR brand associated with the account __Type__ Object | Name | Type | Description | | -------------------------- | ------------------------------------- | --------------------------------------- | | `address1` | String | | | `alt_business_id` | String | | | `alt_business_id_type` | String | | | `brand_relationship` | String | | | `city` | String | | | `company_name` | String | | | `country_code` | String | | | `display_name` | String | | | `ein` | String | | | `ein_issuing_country_code` | String | | | `email` | String | | | `first_name` | String | | | `id` | String(format:ulid) | [Desc. `id`](https://docs.tychron.com/api-reference/csp-brands/#desc-374) | | `inserted_at` | String(format:date-time) | An ISO8601 formatted timestamp | | `last_name` | String | | | `name` | String | A display name to identify the brand | | `notes` | String | Any notes about the brand | | `phone_number` | String | | | `shared` | Enum(`NO`, `OWNED`, `PARTNER`):String | [Desc. `shared`](https://docs.tychron.com/api-reference/csp-brands/#desc-375) | | `state` | String | | | `stock_exchange` | String | | | `stock_symbol` | String | | | `tcr_brand_id` | String | The TCR issued ID of the brand | | `tcr_csp_id` | String | The owning campaign service provider ID | | `universal_ein` | String | | | `updated_at` | String(format:date-time) | An ISO8601 formatted timestamp | | `vertical` | String | | | `website` | String(format:url) | | | `zip_code` | String | | #### Desc. `id` {#desc-374} Another format for UUID, used primarily for tasks, requests and messages. #### Desc. `shared` {#desc-375} Was this brand created directly or was a brand from a partner campaign. Some fields may contain "UNKNOWN" if a brand is from a partner campaign. * `NO` - Should be treated the same as OWNED * `OWNED` - The brand was created on site and belongs to this system * `PARTNER` - The brand originates from outside of the system __Example__ ```json { "address1": "string", "alt_business_id": "string", "alt_business_id_type": "string", "brand_relationship": "string", "city": "string", "company_name": "string", "country_code": "string", "display_name": "string", "ein": "string", "ein_issuing_country_code": "string", "email": "string", "first_name": "string", "id": "01EH2Y28M6KXG14QMPM3HSP1Y0", "inserted_at": "2021-08-13T04:08:44.762841Z", "last_name": "string", "name": "string", "notes": "string", "phone_number": "string", "shared": "NO", "state": "string", "stock_exchange": "string", "stock_symbol": "string", "tcr_brand_id": "B000000", "tcr_csp_id": "S000000", "universal_ein": "string", "updated_at": "2021-08-13T04:08:44.762841Z", "vertical": "string", "website": "string", "zip_code": "string" } ``` ## API ### List CSP Brands ```http GET /api/v1/brands HTTP/1.1 ``` Retrieve a list of brands associated with the account __Query Parameters__ | Name | Type | Description | | ------ | ------- | ------------------------------- | | first | Integer | [Query Desc. first](https://docs.tychron.com/api-reference/csp-brands/#desc-376) | | last | Integer | [Query Desc. last](https://docs.tychron.com/api-reference/csp-brands/#desc-377) | | after | String | [Query Desc. after](https://docs.tychron.com/api-reference/csp-brands/#desc-378) | | before | String | [Query Desc. before](https://docs.tychron.com/api-reference/csp-brands/#desc-379) | #### Query Desc. first {#desc-376} The number of items to return starting from the 'after' cursor #### Query Desc. last {#desc-377} The number of items to return behind the 'before' cursor #### Query Desc. after {#desc-378} The cursor representing the starting point of a 'first' based paging #### Query Desc. before {#desc-379} The cursor representing the starting point of a 'last' based paging #### Request ```http GET /api/v1/brands HTTP/1.1 Accept: application/json ``` #### Response 200 ##### application/json ```http HTTP/1.1 200 Content-Type: application/json Content-Length: 1211 ``` ```json { "count": 1, "page_info": { "first": "string", "has_next_page": true, "has_previous_page": true, "last": "string" }, "results": [ { "data": { "address1": "string", "alt_business_id": "string", "alt_business_id_type": "string", "brand_relationship": "string", "city": "string", "company_name": "string", "country_code": "string", "display_name": "string", "ein": "string", "ein_issuing_country_code": "string", "email": "string", "first_name": "string", "id": "01EH2Y28M6KXG14QMPM3HSP1Y0", "inserted_at": "2021-08-13T04:08:44.762841Z", "last_name": "string", "name": "string", "notes": "string", "phone_number": "string", "shared": "NO", "state": "string", "stock_exchange": "string", "stock_symbol": "string", "tcr_brand_id": "B000000", "tcr_csp_id": "S000000", "universal_ein": "string", "updated_at": "2021-08-13T04:08:44.762841Z", "vertical": "string", "website": "string", "zip_code": "string" }, "type": "csp_brand" } ] } ``` #### Response 403 ##### application/json ```http HTTP/1.1 403 Content-Type: application/json Content-Length: 312 ``` ```json { "errors": [ { "code": "access_denied.no_scope", "detail": "No scope available to user role", "params": { "action": "index", "level": "guest", "resource": "resource" }, "sub_code": "none", "title": "Access Denied, no scope available" } ] } ``` ### Get CSP Brand ```http GET /api/v1/brands/{id} HTTP/1.1 ``` Lookup a Brand by its internal UUID __Path Parameters__ | Name | Type | Description | | ---- | -------------------- | -------------------------- | | id | String(format:uuid)! | [Path Desc. id](https://docs.tychron.com/api-reference/csp-brands/#desc-380) | #### Path Desc. id {#desc-380} Brand ID A Universally unique identifier, which identifies the resource #### Request ```http GET /api/v1/brands/{id} HTTP/1.1 Accept: application/json ``` #### Response 200 ##### application/json ```http HTTP/1.1 200 Content-Type: application/json Content-Length: 914 ``` ```json { "data": { "address1": "string", "alt_business_id": "string", "alt_business_id_type": "string", "brand_relationship": "string", "city": "string", "company_name": "string", "country_code": "string", "display_name": "string", "ein": "string", "ein_issuing_country_code": "string", "email": "string", "first_name": "string", "id": "01EH2Y28M6KXG14QMPM3HSP1Y0", "inserted_at": "2021-08-13T04:08:44.762841Z", "last_name": "string", "name": "string", "notes": "string", "phone_number": "string", "shared": "NO", "state": "string", "stock_exchange": "string", "stock_symbol": "string", "tcr_brand_id": "B000000", "tcr_csp_id": "S000000", "universal_ein": "string", "updated_at": "2021-08-13T04:08:44.762841Z", "vertical": "string", "website": "string", "zip_code": "string" }, "type": "csp_brand" } ``` #### Response 403 ##### application/json ```http HTTP/1.1 403 Content-Type: application/json Content-Length: 312 ``` ```json { "errors": [ { "code": "access_denied.no_scope", "detail": "No scope available to user role", "params": { "action": "index", "level": "guest", "resource": "resource" }, "sub_code": "none", "title": "Access Denied, no scope available" } ] } ``` #### Response 404 ##### application/json ```http HTTP/1.1 404 Content-Type: application/json Content-Length: 314 ``` ```json { "errors": [ { "code": "not_found", "detail": "The specified resource could not be found", "params": { "resource": { "id": "3fbb573a-6049-44a0-a12c-d3a1ffae0b69", "type": "user" } }, "sub_code": "none", "title": "Not Found" } ] } ``` --- Previous chapter: https://docs.tychron.com/api-reference/csp-enums.md Next chapter: https://docs.tychron.com/api-reference/csp-campaigns.md Complete reference in one file: https://docs.tychron.com/llms-full.txt