List billing profile contacts

Returns the contacts attached to a billing profile, with the manager designation and the separate grant that lets a contact see every ticket attributed to the profile in the client portal.

RBAC · client

Path parameters

idstring <uuid>Required

profileIdstring <uuid>Required

Response body

Success response 200 · schema BillingProfileContactsEnvelope

dataarray of BillingProfileContactResourceRequired

itemsobject

contact_name_idstring <uuid>Required

full_namestringRequired

emailstringRequiredNullable

is_managerbooleanRequired

can_view_profile_ticketsbooleanRequired

Lets this contact see every ticket attributed to the profile in the client portal.

metaobject

Response codes

200

Billing profile contacts returned.

400

Invalid client or profile id format.

401

API key missing/invalid or key user not found.

403

Permission denied for client read.

404

Billing profile not found for this client.

500

Unexpected billing profile contacts failure.

GET /api/v1/clients/{id}/billing-profiles/{profileId}/contacts

cURL

curl -X GET "https://algapsa.com/api/v1/clients/{id}/billing-profiles/{profileId}/contacts" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/clients/{id}/billing-profiles/{profileId}/contacts", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/v1/clients/{id}/billing-profiles/{profileId}/contacts");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": [
    {
      "contact_name_id": "01HN2K7VRB9PQ3Y0000000000",
      "full_name": "string",
      "email": "string",
      "is_manager": false,
      "can_view_profile_tickets": false
    }
  ],
  "meta": {}
}