Skip to main content
How can we help you?
Categorieën
< Alle onderwerpen
Printen

LesLinq API

Vernieuwd

Integrations with external systems such as DeepL, Power BI, and others are created through APIs. These APIs define in a consistent way which information is available and how it can be accessed by users.

This article provides detailed information about using the LesLinq API. It explains the required request formats, available endpoints, and how to set up the integration with the system.

Authentication

The LesLinq API uses key-based authorization. This means that every API request must include a valid API key to access secured resources. Requests without a valid key, or with missing authentication, will be denied.

API credentials

Authorized customers can find their API endpoints and tokens on the Settings page within the LesLinq platform.

The list of available endpoints can be accessed via: Endpoint/swagger (example: https://appapi.leslinq.com/swagger). Use the same token from the Settings page to explore the available endpoints.


Authorization

The API key must be sent in the Authorization header using the following format:

Authorization: Bearer xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx
  • The prefix Bearer is required
  • Replace the placeholder with your actual API key

Where can I find my API key?

Authorized customers can view and retrieve their API key via the Settings page in LesLinq.

LesLinq API Endpoints

Participants

1. Get all participants

Endpoint
GET /api/Client/Participants/Get

Description
Retrieves a list of all participants associated with the authenticated client.

Response

200 OK
Returns an array of participant objects.

Example:
[
{
"Id": "EncryptedParticipantId",
"Name": "Participant Name",
"Email": "participant@example.com",
…
}
]

400 Bad Request
No records found

500 Internal Server Error
Unexpected server error

2. Get Participant by ID

Endpoint
GET /api/Client/Participants/Get/{id}

Description
Retrieves detailed information about a single participant based on the encrypted ID.

Response

200 OK

{
"Id": "EncryptedParticipantId",
"Name": "Participant Name",
"Email": "participant@example.com",
…
}

404 Not Found
No participant matches the provided ID

500 Internal Server Error
Unexpected server error

Projects

1. Get all projects

Endpoint
GET /api/Client/Projects/Get

Description
Retrieves a list of all projects associated with the authenticated client.

Response

200 OK
Returns an array of project objects.

Example:
[
{
"Id": "EncryptedProjectId",
"ProjectName": "Project Name",
"Description": "Project Description",
…
}
]

400 Bad Request
No records found

500 Internal Server Error
Unexpected server error

2. Get Project by ID

Endpoint
GET /api/Client/Projects/Get/{id}

Description
Retrieves detailed information about a single project based on the encrypted ID.

Response
200 OK

{
"Id": "EncryptedProjectId",
"ProjectName": "Project Name",
"Description": "Project Description",
…
}

404 Not Found
Returned if no project matches the provided ID

500 Internal Server Error
Unexpected server error

3. Get all participant attempts

Endpoint
GET /api/Client/Projects/Attempts

Description
Retrieves all participant attempts linked to the client’s projects.

Response

200 OK
Returns an array of participant attempt objects.

Example:
[
{
"ProjectId": "EncryptedProjectId",
"ProjectName": "Project Name",
"ParticipantId": "EncryptedParticipantId",
"ParticipantName": "Participant Name",
"ShareOrDistributionType": "Email",
"ShareOrDistributionName": "Share or Distribution Name",
"Status": "Completed",
"StartTime": "2025-12-09T11:00:00Z",
"Attempt": 1,
…
}
]

400 Bad Request
No records found

500 Internal Server Error
Unexpected server error

Tags

1. Alle Tag Types ophalen

Endpoint
GET /api/Client/Tags/Types

Description
Retrieves a list of all tag types associated with the authenticated client.

Response
200 OK
Returns an array of tag type objects.

Example:
[
{
"Id": "EncryptedTagTypeId",
"Name": "Tag Type",
"Status": "Active"
}
]

400 Bad Request
No records found

500 Internal Server Error
Unexpected server error

2. Get Tag Type by ID

Endpoint
GET /api/Client/Tags/Types/{id}

Description
Retrieves a specific tag type based on the encrypted ID.

Response
200 OK

{
"Id": "EncryptedTagTypeId",
"Name": "Tag Type",
"Status": "Active"
}

404 Not Found
Tag type not found

500 Internal Server Error
Unexpected server error

3. Get All Tags

Endpoint
GET /api/Client/Tags/Get

Description
Retrieves all tags associated with the authenticated client.

Response
200 OK
[
{
"Id": "EncryptedTagId",
"Name": "Tag Name",
"TagType": "EncryptedTagTypeId",
"Status": "Active"
}
]

400 Bad Request
No records found

500 Internal Server Error
Unexpected server error

4. Get Tag by ID

Endpoint
GET /api/Client/Tags/Get/{id}

Description
Retrieves a specific tag based on the encrypted ID.

Response
200 OK

{
"Id": "EncryptedTagId",
"Name": "Tag Name",
"TagType": "EncryptedTagTypeId",
"Status": "Active"
}

404 Not Found
Tag not found

500 Internal Server Error
Unexpected server error

5. Get All User Tags

Endpoint
GET /api/Client/Users/Tags

Description
Retrieves all tags assigned to users under the authenticated client.

Response
200 OK
[
{
"UserId": "EncryptedUserId",
"TagId": "EncryptedTagId"
}
]

400 Bad Request
No records found

500 Internal Server Error
Unexpected server error

6. Get all participant tags

Endpoint
GET /api/Client/Participants/Tags

Description
Retrieves all tag associations for participants.

Response
200 OK

[
{
"ParticipantId": "EncryptedParticipantId",
"TagId": "EncryptedTagId"
}
]

400 Bad Request
No records found

500 Internal Server Error
Unexpected server error

7. Get All Project Tags

Endpoint
GET /api/Client/Projects/Tags

Description
Retrieves all tag associations for projects.

Response
200 OK

[
{
"ProjectId": "EncryptedProjectId",
"TagId": "EncryptedTagId"
}
]

400 Bad Request
No records found

500 Internal Server Error
Unexpected server error

Users

1. Get All Users

Endpoint
GET /api/Client/Users/Get

Description
Retrieves a list of all users associated with the authenticated client.

Response
200 OK
Returns an array of user objects.

Example:

[
{
"Id": "EncryptedUserId",
"Name": "John Doe",
"Email": "john@example.com",
…
}
]

400 Bad Request
No records found

500 Internal Server Error
Unexpected server error

2. Get Users by ID

Endpoint
GET /api/Client/Users/Get/{id}

Description
Retrieves details of a specific user.

Response
200 OK
Returns the matching user object.

{
"Id": "EncryptedUserId",
"Name": "John Doe",
"Email": "john@example.com",
…
}

400 Bad Request
No records found

500 Internal Server Error
Unexpected server error

Inhoudsopgave