BixelDocs
API reference

Get a category

GET
/v1/categories/{slug}

Get one category's membership with a per-member rollup: per-dimension fact counts, last capture date, and active-posting count for every company in the category.

Path Parameters

slug*string

Category slug from /v1/categories, e.g. vector-databases.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/categories/vector-databases"
{  "data": {    "companies": [      {        "name": "string",        "domain": "string",        "slug": "string",        "last_captured_at": "2019-08-24",        "jobs": {          "active_postings": 0,          "ats_tracked": true,          "note": "string"        },        "dimensions": {          "property1": 0,          "property2": 0        },        "coverage": {          "dimensions_captured": 0,          "dimensions_total": 0,          "per_dimension": {            "property1": 0,            "property2": 0          },          "thin": true        }      }    ]  },  "meta": {    "generated_at": "2019-08-24T14:15:22Z",    "count": 0,    "total": 0,    "next_cursor": "string",    "notice": "string"  }}
{  "type": "http://example.com",  "title": "string",  "status": 0,  "code": "company_not_found",  "detail": "string",  "hint": "string",  "docs_url": "http://example.com"}
{  "type": "http://example.com",  "title": "string",  "status": 0,  "code": "company_not_found",  "detail": "string",  "hint": "string",  "docs_url": "http://example.com"}
{  "type": "http://example.com",  "title": "string",  "status": 0,  "code": "company_not_found",  "detail": "string",  "hint": "string",  "docs_url": "http://example.com"}