Relay docs
API ReferenceProducts

Get a product

Returns a single product, including archived ones. Requires the `products:read` scope.

GET
/v1/public/products/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

Workspace API key, e.g. rl_live_….

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/public/products/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "id": "7d3c2f9a-1111-4222-8333-444455556666",  "name": "Acme Billing",  "slug": "acme-billing",  "website": "https://billing.acme.com",  "description": "Invoicing for SMBs.",  "logoUrl": "https://cdn.relay.app/p/acme.png",  "archivedAt": null,  "createdAt": "2026-06-01T09:00:00.000Z",  "updatedAt": "2026-08-01T12:30:00.000Z"}
{  "error": "string"}
{  "error": "string"}
{  "error": "string"}

Create a company POST

Creates a company. Requires the `companies:write` scope (`contacts:write` is also accepted for keys issued before it existed).

List products GET

Lists the workspace's products, oldest first. Archived products are omitted unless `include_archived=true`. Requires the `products:read` scope.