Clients

List Clients

get

Retrieve client-console users and their scoped project access.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

get/clients

GET /agency/clients HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "success": true,
  "code": 200,
  "data": [
    {
      "id": 84,
      "uuid": "31a5e9d6-9a58-45a6-a04d-5e45c7601a38",
      "role_slug": "manager",
      "invite_email": "[e-mail]",
      "invited_at": 1714507200,
      "joined_at": null,
      "created_at": 1714507200,
      "updated_at": 1714593600,
      "sections": [
        {
          "id": 7,
          "slug": "reviews",
          "uuid": "5f7f85d1-50d6-4b2c-998c-d04fc6f1a7e9"
        }
      ],
      "projects": [
        {
          "id": 42,
          "name": "Acme Dental",
          "slug": "acme-dental",
          "uuid": "9b58d4c2-8f4f-4a0c-9d55-53db5c9e0a21",
          "is_active": true,
          "is_paused": false,
          "is_suspended": false,
          "features": {
            "asks": 500,
            "customers": 10000,
            "locations": 10,
            "members": 25,
            "links": 10,
            "tags": 50,
            "widgets": 5,
            "api": true,
            "webhooks": true,
            "forms_advanced": true,
            "ambassador": false
          },
          "created_at": 1714507200,
          "updated_at": 1714593600
        }
      ]
    }
  ]
}

Invite Client

post

Invite a client user and assign project or section access.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Object containing response data for this resource.

emailstring · emailRequired

Email address of the client user to invite.

project_idsinteger[]Required

Project identifiers the client can access.

role_slugstring · enumOptional

Role slug that controls the user's permissions.

Possible values:

section_idsinteger[]Optional

Product section identifiers the client can access.

Responses

200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

post/clients

POST /agency/clients HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 94

{
  "email": "[e-mail]",
  "project_ids": [
    42
  ],
  "role_slug": "manager",
  "section_ids": [
    7
  ]
}

200

Success

{
  "success": true,
  "code": 200,
  "data": {
    "id": 84,
    "uuid": "31a5e9d6-9a58-45a6-a04d-5e45c7601a38",
    "role_slug": "manager",
    "invite_email": "[e-mail]",
    "invited_at": 1714507200,
    "joined_at": null,
    "created_at": 1714507200,
    "updated_at": 1714593600,
    "sections": [
      {
        "id": 7,
        "slug": "reviews",
        "uuid": "5f7f85d1-50d6-4b2c-998c-d04fc6f1a7e9"
      }
    ],
    "projects": [
      {
        "id": 42,
        "name": "Acme Dental",
        "slug": "acme-dental",
        "uuid": "9b58d4c2-8f4f-4a0c-9d55-53db5c9e0a21",
        "is_active": true,
        "is_paused": false,
        "is_suspended": false,
        "features": {
          "asks": 500,
          "customers": 10000,
          "locations": 10,
          "members": 25,
          "links": 10,
          "tags": 50,
          "widgets": 5,
          "api": true,
          "webhooks": true,
          "forms_advanced": true,
          "ambassador": false
        },
        "created_at": 1714507200,
        "updated_at": 1714593600
      }
    ]
  }
}

Update Client

put

Change a client user's role and accessible projects or sections.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

client_idintegerRequired

Unique numeric identifier for the client user.

Body

Object containing response data for this resource.

role_slugstring · enumOptional

Role slug that controls the user's permissions.

Possible values:

project_idsinteger[]Optional

Project identifiers the client can access.

section_idsinteger[]Optional

Product section identifiers the client can access.

Responses

200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

put/clients/{client_id}

PUT /agency/clients/{client_id} HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "role_slug": "viewer",
  "project_ids": [
    42
  ],
  "section_ids": [
    7
  ]
}

200

Success

{
  "success": true,
  "code": 200,
  "data": {
    "id": 84,
    "uuid": "31a5e9d6-9a58-45a6-a04d-5e45c7601a38",
    "role_slug": "viewer",
    "invite_email": "[e-mail]",
    "invited_at": 1714507200,
    "joined_at": null,
    "created_at": 1714507200,
    "updated_at": 1714593600,
    "sections": [
      {
        "id": 7,
        "slug": "reviews",
        "uuid": "5f7f85d1-50d6-4b2c-998c-d04fc6f1a7e9"
      }
    ],
    "projects": [
      {
        "id": 42,
        "name": "Acme Dental",
        "slug": "acme-dental",
        "uuid": "9b58d4c2-8f4f-4a0c-9d55-53db5c9e0a21",
        "is_active": true,
        "is_paused": false,
        "is_suspended": false,
        "features": {
          "asks": 500,
          "customers": 10000,
          "locations": 10,
          "members": 25,
          "links": 10,
          "tags": 50,
          "widgets": 5,
          "api": true,
          "webhooks": true,
          "forms_advanced": true,
          "ambassador": false
        },
        "created_at": 1714507200,
        "updated_at": 1714593600
      }
    ]
  }
}

Delete Client

delete

Remove a client user's access to the agency console.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

client_idintegerRequired

Unique numeric identifier for the client user.

Responses

200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

delete/clients/{client_id}

DELETE /agency/clients/{client_id} HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "success": true,
  "code": 200
}

Resend Client Invite

post

Send another onboarding invitation to a pending client user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

client_idintegerRequired

Unique numeric identifier for the client user.

Responses

200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

post/clients/{client_id}/resend-invite

POST /agency/clients/{client_id}/resend-invite HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "success": true,
  "code": 200,
  "data": {
    "id": 84,
    "uuid": "31a5e9d6-9a58-45a6-a04d-5e45c7601a38",
    "role_slug": "manager",
    "invite_email": "[e-mail]",
    "invited_at": 1714507200,
    "joined_at": null,
    "created_at": 1714507200,
    "updated_at": 1714593600,
    "sections": [
      {
        "id": 7,
        "slug": "reviews",
        "uuid": "5f7f85d1-50d6-4b2c-998c-d04fc6f1a7e9"
      }
    ],
    "projects": [
      {
        "id": 42,
        "name": "Acme Dental",
        "slug": "acme-dental",
        "uuid": "9b58d4c2-8f4f-4a0c-9d55-53db5c9e0a21",
        "is_active": true,
        "is_paused": false,
        "is_suspended": false,
        "features": {
          "asks": 500,
          "customers": 10000,
          "locations": 10,
          "members": 25,
          "links": 10,
          "tags": 50,
          "widgets": 5,
          "api": true,
          "webhooks": true,
          "forms_advanced": true,
          "ambassador": false
        },
        "created_at": 1714507200,
        "updated_at": 1714593600
      }
    ]
  }
}