Companies REST API Route

Authentication #

Authentication is required for this route and the authenticated user is required to have the ticket manager role. It is recommended that a user with the role of Support Manager or higher is used.

Schema #

When working with the Companies REST API route the following fields can be expected in any responses.

`id` integer	Unique identifier for the company Read Only
`title` object	The name of the company
`slug` string	An alphanumeric identifier for the object unique to its type
`featured_media` integer	ID of the featured media for the object (generally compant logo)
`meta` object	Contains contact information for the company Contains: `_kbs_company_customer`, `_kbs_company_contact`, `_kbs_company_email`, `_kbs_company_phone`, `_kbs_company_website`
`links` object	Links associated with the company

List Company #

Query this endpoint to retrieve a collection of KB Support companies. The response you receive can be controlled and filtered using the URL query parameters below.

Definition #

GET /kbs/v1/companies

Example Request #

$ curl https://example.com/wp-json/kbs/v1/companies

Arguments #

`page`	Current page of the collection Default: `1`
`per_page`	Maximum number of items to be returned in result set Default: `10`
`exclude`	Ensure result set excludes specific company IDs
`include`	Limit result set to specific company IDs
`offset`	Offset the result set by a specific number of items
`order`	Order sort attribute ascending or descending Default: `desc`One of: `asc`, `desc`
`orderby`	Sort collection by object attribute Default: `id` One of: `id`, `user_id`, `name`, `email`, `company_id`, `date`
`search`	Limit result set to specific search string

Retrieve a Single Company #

Definitions #

GET /kbs/v1/tickets/<id>

GET /kbs/v1/tickets/<number>

Example Requests #

$ curl https://example.com/wp-json/kbs/v1/companies/<id>

Arguments #

`id`	WP Post ID of the ticket

Was this article helpful?

We're working hard to ensure we provide you with useful and relevant documentation to help you get the most out of KB Support.

Please take a moment to let us know if you found this article helpful.

Select your rating:

Companies REST API Route

Authentication # Authentication is required for this route and the authenticated user is required to have the ticket manager role. It is recommended that a user with the role of Support Manager or higher is used. Schema # When working with the Companies REST API route the following fields can be expected in any responses.…

KB Article rating: 2.0 based on 1 ratings

Developer Docs REST API Last updated: 21/01/2021

Published by Cristian Raiber

Posts by Cristian Raiber