> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sendo.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# List brands

> This endpoint lists your brands.

This endpoint lists your submitted brands. Brands in `DRAFT` status will not be returned. [Click here](/knowledge-base/brands) for more information about brands.

### URL Params

<ParamField query="limit" type="number">
  The number of brands to return (default 10).
</ParamField>

<ParamField query="skip" type="number">
  The number of brands to skip (i.e. offset).
</ParamField>

### Response

<ResponseField name="brands" type="[brand]">
  An array of brand objects returned.

  <Expandable title="brand fields">
    <ResponseField name="id" type="string">
      The ID of the retrieved brand.
    </ResponseField>

    <ResponseField name="createdAt" type="timestamp">
      The time that the brand was created.
    </ResponseField>

    <ResponseField name="updatedAt" type="timestamp">
      The time the brand was last updated.
    </ResponseField>

    <ResponseField name="status" type="string">
      The status of the brand.

      <Expandable title="brand statuses">
        <ResponseField name="DRAFT" type="string">
          The brand is saved as a draft.
        </ResponseField>

        <ResponseField name="PENDING" type="string">
          The brand is pending verification.
        </ResponseField>

        <ResponseField name="VERIFIED" type="string">
          The brand is verified and active.
        </ResponseField>

        <ResponseField name="UNVERIFIED" type="string">
          The brand is unverified. Please resubmit.
        </ResponseField>

        <ResponseField name="VETTED" type="string">
          The brand is verified and vetted. [(guide)](/knowledge-base/brands)
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="entityType" type="string">
      The type of the legal entity.

      <Expandable title="brand statuses">
        <ResponseField name="SOLE_PROPRIETOR" type="string">
          The brand is a sole proprietorship.
        </ResponseField>

        <ResponseField name="PRIVATE_PROFIT" type="string">
          The brand is a private company.
        </ResponseField>

        <ResponseField name="PUBLIC_PROFIT" type="string">
          The brand is public company.
        </ResponseField>

        <ResponseField name="NON_PROFIT" type="string">
          The brand is nonprofit organization.
        </ResponseField>

        <ResponseField name="GOVERNMENT" type="string">
          The brand is a government organization.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="vetted" type="boolean">
      Whether the brand has been vetted. [(guide)](/knowledge-base/brands)
    </ResponseField>

    <ResponseField name="trustScore" type="number">
      Trust score if the brand is vetted.
    </ResponseField>

    <ResponseField name="displayName" type="string">
      The display name or DBA name of the brand.
    </ResponseField>

    <ResponseField name="entityName" type="string">
      The name of the brand's legal entity.
    </ResponseField>

    <ResponseField name="ein" type="string">
      The EIN for the brand's legal entity.
    </ResponseField>

    <ResponseField name="website" type="string">
      The website URL for the brand.
    </ResponseField>

    <ResponseField name="privacyLink" type="string">
      The privacy policy URL for the brand.
    </ResponseField>

    <ResponseField name="address" type="string">
      The address for the brand.

      <Expandable title="address fields">
        <ResponseField name="street" type="string">
          The street for the address.
        </ResponseField>

        <ResponseField name="city" type="string">
          The city for the address.
        </ResponseField>

        <ResponseField name="state" type="string">
          The state for the address.
        </ResponseField>

        <ResponseField name="postalCode" type="string">
          The postal code for the address.
        </ResponseField>

        <ResponseField name="country" type="string">
          The country for the address.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="contact" type="string">
      The support contact for the brand.

      <Expandable title="contact fields">
        <ResponseField name="firstName" type="string">
          The first name of the contact.
        </ResponseField>

        <ResponseField name="lastName" type="string">
          The last name of the contact.
        </ResponseField>

        <ResponseField name="phone" type="string">
          The phone number for the contact.
        </ResponseField>

        <ResponseField name="email" type="string">
          The email address for the contact.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="error" type="string">
  Error message if the request fails.
</ResponseField>

<ResponseExample>
  ```json Success theme={null}
  {
    "brands": [
      {
        "id": "h4cQ2gls",
        "createdAt": "2023-12-12T12:33:33.630Z",
        "updatedAt": "2023-12-12T12:33:33.630Z",
        "status": "VERIFIED",
        ...
      },
      {
        "id": "A8wm4k2s",
        "createdAt": "2023-12-07T12:33:33.630Z",
        "updatedAt": "2023-12-08T12:33:33.630Z",
        "status": "VETTED",
        ...
      }
      And so on...
    ]
  }
  ```

  ```json Error theme={null}
  {
    "brands": [],
    "error": "Internal server error"
  }
  ```
</ResponseExample>
