1. Authentcation
Adlyft
  • Authentcation
    • Get User Token
      POST
    • Refresh access token
      GET
    • Get User Token
      POST
  • Connections
    • Create Connections
      POST
    • List Connections
      GET
    • Get Connections Status
      GET
    • Delete Connections By Adsaccountid Remove Connection
      DELETE
    • Get Connections By Id Insights
      GET
    • Get all external-user connections
      GET
    • Check connection status
      GET
    • Remove a connection by ads account ID
      DELETE
    • Revoke a connection by connection ID
      DELETE
    • Read Meta ad account insights through the connection surface
      GET
    • Create Connections
      POST
    • List Connections
      GET
    • Generate OAuth authorization URL
      POST
  • Meta
    • Assets & Entities
      • List Meta Pages
      • List Meta Businesses
      • Get Meta Businesses By BusinessId
      • List Meta Businesses By BusinessId Ad Accounts
      • List Meta Businesses
      • Get Meta Businesses By BusinessId
      • List Meta Businesses By BusinessId Ad Accounts
      • List business product catalogs
    • Audiences
      • List saved audiences
      • List custom audiences
      • Create a lookalike audience
      • Estimate audience size
    • Pixels
      • Create a Meta pixel
      • List Meta pixels
      • Get Meta pixel details
      • Get Meta pixel stats
      • Get Meta dataset quality
    • Lead Forms
      • Create a Meta lead form
      • List Meta lead forms
    • Campaigns
      • Create a lead campaign
      • Create an awareness campaign
      • Create a traffic campaign
      • Create an engagement campaign
      • Create a sales campaign
      • List Meta campaigns
      • Get Meta campaign details
      • Update Meta campaign status
    • Insights
      • Read Meta insights
    • Ads
      • List ads for a Meta ad set
      • List Meta ads
      • Update Meta ad status
      • List ads for a Meta campaign
      • Get Meta ad details
      • Update Meta ad set status
      • List Meta ads
    • Adset
      • List Meta ad sets
      • Get Meta ad set details
    • Ad Creatives
      • List Meta ad creatives
      • Preview a Meta ad creative
      • Get Meta ad creative details
    • Account details
      • List Meta ad accounts
      • Get Meta ad account details
    • Import Meta ad account data
      GET
    • Search Meta targeting options
      POST
  • Google Integration
    • List Google List Accessible Accounts
    • List Google Import
    • Get Google Insights
    • List Google Assets
    • List accessible Google ad accounts
    • Import a Google ad account
    • Read Google insights
    • Read Google assets
    • Execute a Google GAQL query
  • TikTok Integration
    • Create TikTok Import
    • List TikTok Assets
    • Get TikTok Insights
    • Create TikTok Assets Status Update
    • Create TikTok Assets Ads
    • Import a TikTok ad account
    • Read TikTok assets
    • Read TikTok insights
    • Update TikTok asset status
    • Create or update TikTok ads payload
  • Schemas
    • StandardSuccessEnvelopeDto
    • CreateConnectionDto
    • CreateLookalikeAudienceDto
    • EstimateAudienceDto
    • LinkedinTenantAppCreateDto
    • PreviewAdcreativeDto
    • ErrorResponse
    • StandardSuccessEnvelope
    • RawSuccessPayload
    • PaginationPageMeta
    • PaginationCursorMeta
    • UpdateAssetStatusRequest
    • AccessTokenDto
    • SearchTargetingRequest
    • AuthUrlDto
    • CreatePixelRequest
    • PreviewRequest
    • ConnectionStatusItemDto
    • CreateLeadFormRequest
    • ConnectionStatusDto
    • CampaignBaseRequest
    • MetaAccessTokenDto
    • CreativeBaseRequest
    • CreateLeadCampaignRequest
    • CreateAwarenessCampaignRequest
    • CreateEngagementCampaignRequest
    • TargetingSearchDto
    • CreateTrafficCampaignRequest
    • CreateSalesCampaignRequest
    • MetaStatusUpdateDto
    • PaginatedUsersResponse
    • MetaCampaignTargeting
  1. Authentcation

Get User Token

POST
auth/token
Use this endpoint to create or trigger auth token in gateway. Authentication: x-api-key.

Request

Authorization
API Key
Add parameter in header
x-api-key
Example:
x-api-key: ********************
or
Header Params

Body Params application/jsonRequired

Examples

Responses

🟢201
application/json
Successful response.
Body

🟠400Error400
🟠401Error401
🟠403Error403
🟠404Error404
🟠409Error409
🟠422Error422
🟠429Error429
🔴500Error500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://qa.api.adlyfy.dev/api/v1/auth/token' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "externalUserId": "ext-user-1"
}'
Response Response Example
201 - Success
{
    "success": true,
    "data": {},
    "message": "Request successful",
    "timestamp": "2026-03-03T10:00:00.000Z",
    "statusCode": 201
}
Modified at 2026-04-14 20:35:27
Next
Refresh access token
Built with