== COMPANIES

The Companies resource is used to list, create, and update company profiles.

=== Retrieve a company

A `GET` request will retrieve the details of a company profile.

==== Response fields

include::{snippets}/companies-get-example/response-fields.adoc[]

==== Example request

include::{snippets}/companies-get-example/http-request.adoc[]

==== Example response

include::{snippets}/companies-get-example/http-response.adoc[]

=== Create a company

A `POST` request will create a new company profile.

==== Request fields

include::{snippets}/companies-create-example/request-fields.adoc[]

==== Response fields

include::{snippets}/companies-create-example/response-fields.adoc[]

==== Example request

include::{snippets}/companies-create-example/http-request.adoc[]

==== Example response

include::{snippets}/companies-create-example/http-response.adoc[]

=== Update a company

A `PUT` request will update the details of a company profile.

==== Request fields

include::{snippets}/companies-update-example/request-fields.adoc[]

==== Response fields

include::{snippets}/companies-update-example/response-fields.adoc[]

==== Example request

include::{snippets}/companies-update-example/http-request.adoc[]

==== Example response

include::{snippets}/companies-update-example/http-response.adoc[]

=== Retrieve a company lookup

A `GET` request will retrieve the details of a company lookup.

==== Response fields

include::{snippets}/companies-get-lookup-example/response-fields.adoc[]

==== Example request

include::{snippets}/compnaies-get-lookup-example/http-request.adoc[]

==== Example response

include::{snippets}/companies-get-lookup-example/http-response.adoc[]