API Docs

List Custom Fields

Learn how to list custom fields using the Blue API.

You can use the Blue API to list custom fields in a specific project. Use the following query:

query ListCustomFields {
  customFields {
    items {
      id
      name
      type
    }
    pageInfo {
      totalItems
    }
  }
}

Required Headers

When making this request, you must include the following headers:

x-bloo-token-id: "your-token-id" x-bloo-token-secret: "your-token-secret" x-bloo-project-id: "project-id-or-slug" x-bloo-company-id: "company-id-or-slug"

The project ID and company ID are required because custom fields are specific to projects. See the Authentication documentation for more details on obtaining these values.

And the sample JSON response:

{
  "data": {
    "customFields": {
      "items": [
        {
          "id": "custom_field_id_1",
          "name": "Field Name 1",
          "type": "FIELD_TYPE"
        },
        {
          "id": "custom_field_id_2",
          "name": "Field Name 2",
          "type": "FIELD_TYPE"
        }
      ],
      "pageInfo": {
        "totalItems": 2
      }
    }
  }
}