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.
When working with the Companies REST API route the following fields can be expected in any responses.
|Unique identifier for the company|
|The name of the company|
|An alphanumeric identifier for the object unique to its type|
|ID of the featured media for the object (generally compant logo)|
|Contains contact information for the company|
|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.
Example Request #
$ curl https://example.com/wp-json/kbs/v1/companies
|Current page of the collection|
|Maximum number of items to be returned in result set|
|Ensure result set excludes specific company IDs|
|Limit result set to specific company IDs|
|Offset the result set by a specific number of items|
|Order sort attribute ascending or descending|
|Sort collection by object attribute|
|Limit result set to specific search string|
Retrieve a Single Company #
Example Requests #
$ curl https://example.com/wp-json/kbs/v1/companies/<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.