Dashform
API Referencev2

Get an Organization

Reads one Organization the caller is a member of.

GET
/organizations/{organizationRef}

Authorization

apiKey
headerx-api-key<token>

A Dashform API key, sent in the x-api-key header. Keys are created in the dashboard and act as the user who owns them.

Path Parameters

organizationRef*||

The Organization, addressed by its canonical id or by its slug, as returned by the Organizations collection. Responses always carry the canonical id.

Response Body

OK

application/json
  1. response

An Organization that owns Projects and controls their access.

createTime*string

RFC 3339 timestamp when the Organization was created.

Formatdate-time
logo*|

Organization logo URL, or null when no logo is configured.

metadata*||||array<string|number|boolean|null|array<unknown|null>|>||

Arbitrary Organization metadata, or null when none is stored.

name*string

Human-readable Organization name.

Length1 <= length <= 80
path*string

Canonical Organization resource path in the form organizations/{organization_id}.

Match^organizations\/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
slug*string

URL-safe Organization slug using lowercase letters, numbers, and hyphens.

Match^(?!(?:new|settings|checkout|forms|oauth)$)[a-z0-9]+(?:-[a-z0-9]+)*$
Length3 <= length <= 48
curl -X GET 'https://getaiform.com/api/v2/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08'
{  "createTime": "2019-08-24T14:15:22Z",  "logo": "string",  "metadata": "string",  "name": "string",  "path": "string",  "slug": "string"}

List the caller's Organizations GET

List a page of Organizations the credential's user belongs to, oldest first. Follow nextPageToken to read subsequent pages.

Интеграция с Zapier (API v1)

API v1, на котором работает интеграция Dashform с Zapier, — аутентификация, эндпоинты и полезная нагрузка вебхуков.