Articles

Get articles

get

Authorizations

Query parameters

containsstringOptional

tagsstring[]Optional

authorsstring · uuid[]Optional

statusstring · enumOptionalPossible values:

pageinteger · int32OptionalDefault: 1

perPageinteger · int32OptionalDefault: 20

sortstringOptionalDefault: published

orderstringOptionalDefault: desc

Header parameters

X-TL-CompanyIdguidOptional

Company Id

X-TL-SubdomainguidOptional

Account subdomain

X-TL-UserIdguidOptional

Team member id

Responses

200

Success

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /v2/articles HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Results": [
    {
      "Id": 1,
      "Title": "text",
      "Text": "text",
      "MetaDescription": "text",
      "MetaTitle": "text",
      "ImageUrl": "text",
      "Author": {
        "Id": "123e4567-e89b-12d3-a456-426614174000",
        "Name": "text",
        "Email": "text",
        "SenderEmail": "text",
        "Username": "text",
        "Headline": "text",
        "Avatar": "text",
        "Role": "Administrator",
        "InvitationSentTime": "2025-07-06T22:56:17.820Z",
        "Permissions": {
          "Jobs": [
            {
              "Id1": 1,
              "Id2": "text"
            }
          ],
          "ExcludedJobs": [
            {
              "Id1": 1,
              "Id2": "text"
            }
          ],
          "Departments": [
            {
              "Id1": 1,
              "Id2": "text"
            }
          ],
          "Sites": [
            {
              "Id1": 1,
              "Id2": "text"
            }
          ]
        }
      },
      "LastModifiedBy": {
        "Id": "123e4567-e89b-12d3-a456-426614174000",
        "Name": "text",
        "Email": "text",
        "SenderEmail": "text",
        "Username": "text",
        "Headline": "text",
        "Avatar": "text",
        "Role": "Administrator",
        "InvitationSentTime": "2025-07-06T22:56:17.820Z",
        "Permissions": {
          "Jobs": [
            {
              "Id1": 1,
              "Id2": "text"
            }
          ],
          "ExcludedJobs": [
            {
              "Id1": 1,
              "Id2": "text"
            }
          ],
          "Departments": [
            {
              "Id1": 1,
              "Id2": "text"
            }
          ],
          "Sites": [
            {
              "Id1": 1,
              "Id2": "text"
            }
          ]
        }
      },
      "AbsoluteUrl": "text",
      "RelativeUrl": "text",
      "Slug": "text",
      "LastModified": "2025-07-06T22:56:17.820Z",
      "Published": "2025-07-06T22:56:17.820Z",
      "Status": "Draft",
      "Tags": [
        "text"
      ],
      "AuthorPublishedFormatted": "text"
    }
  ],
  "Count": 1,
  "Page": 1,
  "PerPage": 1,
  "Pages": {
    "First": "text",
    "Prev": "text",
    "Next": "text",
    "Last": "text"
  },
  "IdResults": [
    {
      "Id": 1,
      "Title": "text",
      "Text": "text",
      "MetaDescription": "text",
      "MetaTitle": "text",
      "ImageUrl": "text",
      "Author": {
        "Id": "123e4567-e89b-12d3-a456-426614174000",
        "Name": "text",
        "Email": "text",
        "SenderEmail": "text",
        "Username": "text",
        "Headline": "text",
        "Avatar": "text",
        "Role": "Administrator",
        "InvitationSentTime": "2025-07-06T22:56:17.820Z",
        "Permissions": {
          "Jobs": [
            {
              "Id1": 1,
              "Id2": "text"
            }
          ],
          "ExcludedJobs": [
            {
              "Id1": 1,
              "Id2": "text"
            }
          ],
          "Departments": [
            {
              "Id1": 1,
              "Id2": "text"
            }
          ],
          "Sites": [
            {
              "Id1": 1,
              "Id2": "text"
            }
          ]
        }
      },
      "LastModifiedBy": {
        "Id": "123e4567-e89b-12d3-a456-426614174000",
        "Name": "text",
        "Email": "text",
        "SenderEmail": "text",
        "Username": "text",
        "Headline": "text",
        "Avatar": "text",
        "Role": "Administrator",
        "InvitationSentTime": "2025-07-06T22:56:17.820Z",
        "Permissions": {
          "Jobs": [
            {
              "Id1": 1,
              "Id2": "text"
            }
          ],
          "ExcludedJobs": [
            {
              "Id1": 1,
              "Id2": "text"
            }
          ],
          "Departments": [
            {
              "Id1": 1,
              "Id2": "text"
            }
          ],
          "Sites": [
            {
              "Id1": 1,
              "Id2": "text"
            }
          ]
        }
      },
      "AbsoluteUrl": "text",
      "RelativeUrl": "text",
      "Slug": "text",
      "LastModified": "2025-07-06T22:56:17.820Z",
      "Published": "2025-07-06T22:56:17.820Z",
      "Status": "Draft",
      "Tags": [
        "text"
      ],
      "AuthorPublishedFormatted": "text"
    }
  ],
  "OriginalCount": 1
}

Get article

get

Authorizations

Path parameters

idinteger · int32Required

Header parameters

X-TL-CompanyIdguidOptional

Company Id

X-TL-SubdomainguidOptional

Account subdomain

X-TL-UserIdguidOptional

Team member id

Responses

200

Success

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /v2/articles/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Id": 1,
  "Title": "text",
  "Text": "text",
  "MetaDescription": "text",
  "MetaTitle": "text",
  "ImageUrl": "text",
  "Author": {
    "Id": "123e4567-e89b-12d3-a456-426614174000",
    "Name": "text",
    "Email": "text",
    "SenderEmail": "text",
    "Username": "text",
    "Headline": "text",
    "Avatar": "text",
    "Role": "Administrator",
    "InvitationSentTime": "2025-07-06T22:56:17.820Z",
    "Permissions": {
      "Jobs": [
        {
          "Id1": 1,
          "Id2": "text"
        }
      ],
      "ExcludedJobs": [
        {
          "Id1": 1,
          "Id2": "text"
        }
      ],
      "Departments": [
        {
          "Id1": 1,
          "Id2": "text"
        }
      ],
      "Sites": [
        {
          "Id1": 1,
          "Id2": "text"
        }
      ]
    }
  },
  "LastModifiedBy": {
    "Id": "123e4567-e89b-12d3-a456-426614174000",
    "Name": "text",
    "Email": "text",
    "SenderEmail": "text",
    "Username": "text",
    "Headline": "text",
    "Avatar": "text",
    "Role": "Administrator",
    "InvitationSentTime": "2025-07-06T22:56:17.820Z",
    "Permissions": {
      "Jobs": [
        {
          "Id1": 1,
          "Id2": "text"
        }
      ],
      "ExcludedJobs": [
        {
          "Id1": 1,
          "Id2": "text"
        }
      ],
      "Departments": [
        {
          "Id1": 1,
          "Id2": "text"
        }
      ],
      "Sites": [
        {
          "Id1": 1,
          "Id2": "text"
        }
      ]
    }
  },
  "AbsoluteUrl": "text",
  "RelativeUrl": "text",
  "Slug": "text",
  "LastModified": "2025-07-06T22:56:17.820Z",
  "Published": "2025-07-06T22:56:17.820Z",
  "Status": "Draft",
  "Tags": [
    "text"
  ],
  "AuthorPublishedFormatted": "text"
}