Merchants

Get merchant by id.

GET

http://localhost:3000/api/merchants/{id}

Get merchant by id.

curl -X GET 'http://localhost:3000/api/merchants/string' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('http://localhost:3000/api/merchants/string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'http://localhost:3000/api/merchants/string',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "deletedAt": "2018-11-21T06:20:32.232Z",
  "createdAt": "2018-11-21T06:20:32.232Z",
  "updatedAt": "2018-11-21T06:20:32.232Z",
  "id": "string",
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "tenantId": "string",
  "organizationId": "string",
  "name": "string",
  "code": "string",
  "email": "string",
  "phone": "string",
  "description": "string",
  "active": true,
  "currency": "string",
  "contact": {
    "deletedAt": "2018-11-21T06:20:32.232Z",
    "createdAt": "2018-11-21T06:20:32.232Z",
    "updatedAt": "2018-11-21T06:20:32.232Z",
    "id": "string",
    "isActive": true,
    "isArchived": false,
    "archivedAt": "2018-11-21T06:20:32.232Z",
    "tenantId": "string",
    "organizationId": "string",
    "name": "string",
    "firstName": "string",
    "lastName": "string",
    "country": "string",
    "city": "string",
    "address": "string",
    "address2": "string",
    "postcode": "string",
    "latitude": 0,
    "longitude": 0,
    "regionCode": "string",
    "fax": "string",
    "fiscalInformation": "string",
    "website": "string"
  },
  "contactId": "string",
  "logo": {
    "deletedAt": "2018-11-21T06:20:32.232Z",
    "createdAt": "2018-11-21T06:20:32.232Z",
    "updatedAt": "2018-11-21T06:20:32.232Z",
    "id": "string",
    "isActive": true,
    "isArchived": false,
    "archivedAt": "2018-11-21T06:20:32.232Z",
    "tenantId": "string",
    "organizationId": "string",
    "name": "string",
    "url": "string",
    "thumb": "string",
    "width": 0,
    "height": 0,
    "size": 0,
    "isFeatured": true,
    "externalProviderId": "string",
    "storageProvider": "LOCAL",
    "productFeaturedImage": [
      {
        "deletedAt": "2018-11-21T06:20:32.232Z",
        "createdAt": "2018-11-21T06:20:32.232Z",
        "updatedAt": "2018-11-21T06:20:32.232Z",
        "id": "string",
        "isActive": true,
        "isArchived": false,
        "archivedAt": "2018-11-21T06:20:32.232Z",
        "tenantId": "string",
        "organizationId": "string",
        "enabled": true,
        "code": "string",
        "imageUrl": "string",
        "featuredImageId": "string",
        "productType": {
          "deletedAt": "2018-11-21T06:20:32.232Z",
          "createdAt": "2018-11-21T06:20:32.232Z",
          "updatedAt": "2018-11-21T06:20:32.232Z",
          "id": "string",
          "isActive": true,
          "isArchived": false,
          "archivedAt": "2018-11-21T06:20:32.232Z",
          "tenantId": "string",
          "organizationId": "string",
          "icon": "briefcase-outline",
          "products": [],
          "translations": [
            {
              "deletedAt": "2018-11-21T06:20:32.232Z",
              "createdAt": "2018-11-21T06:20:32.232Z",
              "updatedAt": "2018-11-21T06:20:32.232Z",
              "id": "string",
              "isActive": true,
              "isArchived": false,
              "archivedAt": "2018-11-21T06:20:32.232Z",
              "tenantId": "string",
              "organizationId": "string",
              "name": "string",
              "description": "string",
              "languageCode": "string",
              "referenceId": "string"
            }
          ]
        },
        "productTypeId": "string",
        "productCategory": {
          "deletedAt": "2018-11-21T06:20:32.232Z",
          "createdAt": "2018-11-21T06:20:32.232Z",
          "updatedAt": "2018-11-21T06:20:32.232Z",
          "id": "string",
          "isActive": true,
          "isArchived": false,
          "archivedAt": "2018-11-21T06:20:32.232Z",
          "tenantId": "string",
          "organizationId": "string",
          "imageUrl": "string",
          "imageId": "string",
          "products": [],
          "translations": [
            {
              "deletedAt": "2018-11-21T06:20:32.232Z",
              "createdAt": "2018-11-21T06:20:32.232Z",
              "updatedAt": "2018-11-21T06:20:32.232Z",
              "id": "string",
              "isActive": true,
              "isArchived": false,
              "archivedAt": "2018-11-21T06:20:32.232Z",
              "tenantId": "string",
              "organizationId": "string",
              "name": "string",
              "description": "string",
              "languageCode": "string",
              "referenceId": "string"
            }
          ]
        },
        "productCategoryId": "string",
        "translations": [
          {
            "deletedAt": "2018-11-21T06:20:32.232Z",
            "createdAt": "2018-11-21T06:20:32.232Z",
            "updatedAt": "2018-11-21T06:20:32.232Z",
            "id": "string",
            "isActive": true,
            "isArchived": false,
            "archivedAt": "2018-11-21T06:20:32.232Z",
            "tenantId": "string",
            "organizationId": "string",
            "name": "string",
            "description": "string",
            "languageCode": "en",
            "referenceId": "string"
          }
        ],
        "variants": [
          {
            "deletedAt": "2018-11-21T06:20:32.232Z",
            "createdAt": "2018-11-21T06:20:32.232Z",
            "updatedAt": "2018-11-21T06:20:32.232Z",
            "id": "string",
            "isActive": true,
            "isArchived": false,
            "archivedAt": "2018-11-21T06:20:32.232Z",
            "tenantId": "string",
            "organizationId": "string",
            "taxes": 0,
            "notes": "string",
            "quantity": 0,
            "billingInvoicingPolicy": "string",
            "internalReference": "string",
            "enabled": true,
            "productId": "string",
            "imageId": "string",
            "warehouseProductVariants": [],
            "options": {
              "deletedAt": "2018-11-21T06:20:32.232Z",
              "createdAt": "2018-11-21T06:20:32.232Z",
              "updatedAt": "2018-11-21T06:20:32.232Z",
              "id": "string",
              "isActive": true,
              "isArchived": false,
              "archivedAt": "2018-11-21T06:20:32.232Z",
              "tenantId": "string",
              "organizationId": "string",
              "name": "string",
              "code": "string",
              "groupId": "string",
              "translations": [
                {
                  "deletedAt": "2018-11-21T06:20:32.232Z",
                  "createdAt": "2018-11-21T06:20:32.232Z",
                  "updatedAt": "2018-11-21T06:20:32.232Z",
                  "id": "string",
                  "isActive": true,
                  "isArchived": false,
                  "archivedAt": "2018-11-21T06:20:32.232Z",
                  "tenantId": "string",
                  "organizationId": "string",
                  "name": "string",
                  "description": "string",
                  "languageCode": "en",
                  "referenceId": "string"
                }
              ]
            }
          }
        ],
        "optionGroups": [
          {
            "deletedAt": "2018-11-21T06:20:32.232Z",
            "createdAt": "2018-11-21T06:20:32.232Z",
            "updatedAt": "2018-11-21T06:20:32.232Z",
            "id": "string",
            "isActive": true,
            "isArchived": false,
            "archivedAt": "2018-11-21T06:20:32.232Z",
            "tenantId": "string",
            "organizationId": "string",
            "name": "string",
            "productId": "string",
            "options": [],
            "translations": [
              {
                "deletedAt": "2018-11-21T06:20:32.232Z",
                "createdAt": "2018-11-21T06:20:32.232Z",
                "updatedAt": "2018-11-21T06:20:32.232Z",
                "id": "string",
                "isActive": true,
                "isArchived": false,
                "archivedAt": "2018-11-21T06:20:32.232Z",
                "tenantId": "string",
                "organizationId": "string",
                "name": "string",
                "languageCode": "en",
                "referenceId": "string"
              }
            ]
          }
        ],
        "invoiceItems": [
          {
            "deletedAt": "2018-11-21T06:20:32.232Z",
            "createdAt": "2018-11-21T06:20:32.232Z",
            "updatedAt": "2018-11-21T06:20:32.232Z",
            "id": "string",
            "isActive": true,
            "isArchived": false,
            "archivedAt": "2018-11-21T06:20:32.232Z",
            "tenantId": "string",
            "organizationId": "string",
            "description": "string",
            "price": 0,
            "quantity": 0,
            "totalValue": 0,
            "applyTax": true,
            "applyDiscount": true,
            "expense": {
              "deletedAt": "2018-11-21T06:20:32.232Z",
              "createdAt": "2018-11-21T06:20:32.232Z",
              "updatedAt": "2018-11-21T06:20:32.232Z",
              "id": "string",
              "isActive": true,
              "isArchived": false,
              "archivedAt": "2018-11-21T06:20:32.232Z",
              "tenantId": "string",
              "organizationId": "string",
              "amount": 0,
              "typeOfExpense": "string",
              "notes": "string",
              "currency": "AFN",
              "valueDate": "2024-01-15T09:30:00Z",
              "purpose": "string",
              "taxType": "string",
              "taxLabel": "string",
              "rateValue": 0,
              "receipt": "string",
              "splitExpense": true,
              "reference": "string",
              "status": "INVOICED",
              "employee": {},
              "employeeId": "string",
              "vendor": {
                "deletedAt": "2018-11-21T06:20:32.232Z",
                "createdAt": "2018-11-21T06:20:32.232Z",
                "updatedAt": "2018-11-21T06:20:32.232Z",
                "id": "string",
                "isActive": true,
                "isArchived": false,
                "archivedAt": "2018-11-21T06:20:32.232Z",
                "tenantId": "string",
                "organizationId": "string",
                "name": "string",
                "email": "string",
                "phone": "string",
                "website": "string",
                "expenses": []
              },
              "vendorId": "string",
              "category": {
                "deletedAt": "2018-11-21T06:20:32.232Z",
                "createdAt": "2018-11-21T06:20:32.232Z",
                "updatedAt": "2018-11-21T06:20:32.232Z",
                "id": "string",
                "isActive": true,
                "isArchived": false,
                "archivedAt": "2018-11-21T06:20:32.232Z",
                "tenantId": "string",
                "organizationId": "string",
                "name": "string",
                "expenses": []
              },
              "categoryId": "string",
              "project": {},
              "projectId": "string",
              "organizationContact": {
                "deletedAt": "2018-11-21T06:20:32.232Z",
                "createdAt": "2018-11-21T06:20:32.232Z",
                "updatedAt": "2018-11-21T06:20:32.232Z",
                "id": "string",
                "isActive": true,
                "isArchived": false,
                "archivedAt": "2018-11-21T06:20:32.232Z",
                "tenantId": "string",
                "organizationId": "string",
                "name": "string",
                "primaryEmail": "string",
                "primaryPhone": "string",
                "inviteStatus": "NOT_INVITED",
                "notes": "string",
                "contactType": "CLIENT",
                "imageUrl": "string",
                "budget": 0,
                "budgetType": "string",
                "contact": {},
                "contactId": "string",
                "imageId": "string",
                "expenses": [],
                "incomes": [
                  {
                    "deletedAt": "2018-11-21T06:20:32.232Z",
                    "createdAt": "2018-11-21T06:20:32.232Z",
                    "updatedAt": "2018-11-21T06:20:32.232Z",
                    "id": "string",
                    "isActive": true,
                    "isArchived": false,
                    "archivedAt": "2018-11-21T06:20:32.232Z",
                    "tenantId": "string",
                    "organizationId": "string",
                    "amount": 0,
                    "currency": "AFN",
                    "valueDate": "2024-01-15T09:30:00Z",
                    "notes": "string",
                    "isBonus": true,
                    "reference": "string",
                    "employee": {},
                    "employeeId": "string",
                    "clientId": "string",
                    "tags": []
                  }
                ],
                "timeLogs": [
                  {
                    "deletedAt": "2018-11-21T06:20:32.232Z",
                    "createdAt": "2018-11-21T06:20:32.232Z",
                    "updatedAt": "2018-11-21T06:20:32.232Z",
                    "id": "string",
                    "isActive": true,
                    "isArchived": false,
                    "archivedAt": "2018-11-21T06:20:32.232Z",
                    "tenantId": "string",
                    "organizationId": "string",
                    "logType": "TRACKED",
                    "source": "BROWSER",
                    "description": "string",
                    "reason": "string",
                    "isBillable": false,
                    "isRunning": true,
                    "version": "1.0.1",
                    "employeeId": "string",
                    "timesheetId": "string",
                    "projectId": "string",
                    "taskId": "string",
                    "organizationContactId": "string",
                    "organizationTeamId": "string"
                  }
                ]
              },
              "organizationContactId": "string",
              "invoiceItems": [],
              "tags": []
            },
            "expenseId": "string",
            "invoice": {
              "deletedAt": "2018-11-21T06:20:32.232Z",
              "createdAt": "2018-11-21T06:20:32.232Z",
              "updatedAt": "2018-11-21T06:20:32.232Z",
              "id": "string",
              "isActive": true,
              "isArchived": false,
              "archivedAt": "2018-11-21T06:20:32.232Z",
              "tenantId": "string",
              "organizationId": "string",
              "invoiceDate": "2024-01-15T09:30:00Z",
              "invoiceNumber": 0,
              "dueDate": "2024-01-15T09:30:00Z",
              "currency": "AFN",
              "discountValue": 0,
              "paid": true,
              "tax": 0,
              "tax2": 0,
              "terms": "string",
              "totalValue": 0,
              "status": "string",
              "isEstimate": true,
              "isAccepted": true,
              "discountType": "PERCENT",
              "taxType": "PERCENT",
              "tax2Type": "PERCENT",
              "invoiceType": "BY_EMPLOYEE_HOURS",
              "sentTo": "string",
              "organizationContactId": "string",
              "internalNote": "string",
              "alreadyPaid": 0,
              "amountDue": 0,
              "hasRemainingAmountInvoiced": true,
              "token": "string",
              "fromOrganization": {
                "select": {},
                "relations": {},
                "where": {},
                "order": {},
                "withDeleted": true,
                "take": 0,
                "skip": 0
              },
              "fromOrganizationId": "string",
              "toContactId": "string",
              "invoiceItems": [],
              "payments": [
                {
                  "deletedAt": "2018-11-21T06:20:32.232Z",
                  "createdAt": "2018-11-21T06:20:32.232Z",
                  "updatedAt": "2018-11-21T06:20:32.232Z",
                  "id": "string",
                  "isActive": true,
                  "isArchived": false,
                  "archivedAt": "2018-11-21T06:20:32.232Z",
                  "tenantId": "string",
                  "organizationId": "string",
                  "paymentDate": "2024-01-15T09:30:00Z",
                  "amount": 0,
                  "note": "string",
                  "currency": "AFN",
                  "paymentMethod": "BANK_TRANSFER",
                  "overdue": true,
                  "employeeId": "string",
                  "invoiceId": "string",
                  "projectId": "string",
                  "organizationContactId": "string",
                  "tags": [
                    []
                  ]
                }
              ],
              "historyRecords": [
                {
                  "deletedAt": "2018-11-21T06:20:32.232Z",
                  "createdAt": "2018-11-21T06:20:32.232Z",
                  "updatedAt": "2018-11-21T06:20:32.232Z",
                  "id": "string",
                  "isActive": true,
                  "isArchived": false,
                  "archivedAt": "2018-11-21T06:20:32.232Z",
                  "tenantId": "string",
                  "organizationId": "string",
                  "action": "string",
                  "title": "string",
                  "user": {
                    "deletedAt": "2018-11-21T06:20:32.232Z",
                    "createdAt": "2018-11-21T06:20:32.232Z",
                    "updatedAt": "2018-11-21T06:20:32.232Z",
                    "id": "string",
                    "isActive": true,
                    "isArchived": false,
                    "archivedAt": "2018-11-21T06:20:32.232Z",
                    "tenantId": "string",
                    "thirdPartyId": "string",
                    "firstName": "string",
                    "lastName": "string",
                    "email": "string",
                    "phoneNumber": "string",
                    "username": "string",
                    "timeZone": "string",
                    "timeFormat": 12,
                    "hash": "string",
                    "refreshToken": "string",
                    "imageUrl": "string",
                    "preferredLanguage": "en",
                    "preferredComponentLayout": "CARDS_GRID",
                    "uiPreferences": {},
                    "code": "string",
                    "codeExpireAt": "2024-01-15T09:30:00Z",
                    "emailVerifiedAt": "2024-01-15T09:30:00Z",
                    "lastLoginAt": "2024-01-15T09:30:00Z",
                    "emailToken": "string",
                    "roleId": "string",
                    "imageId": "string",
                    "defaultTeamId": "string",
                    "lastTeamId": "string",
                    "defaultOrganizationId": "string",
                    "lastOrganizationId": "string"
                  },
                  "userId": "string",
                  "invoiceId": "string"
                }
              ],
              "tags": {}
            },
            "invoiceId": "string",
            "task": {
              "deletedAt": "2018-11-21T06:20:32.232Z",
              "createdAt": "2018-11-21T06:20:32.232Z",
              "updatedAt": "2018-11-21T06:20:32.232Z",
              "id": "string",
              "isActive": true,
              "isArchived": false,
              "archivedAt": "2018-11-21T06:20:32.232Z",
              "tenantId": "string",
              "organizationId": "string",
              "title": "string",
              "description": "string",
              "status": "string",
              "priority": "string",
              "size": "string",
              "issueType": "string",
              "estimate": 0,
              "dueDate": "2024-01-15T09:30:00Z",
              "public": true,
              "startDate": "2024-01-15T09:30:00Z",
              "resolvedAt": "2024-01-15T09:30:00Z",
              "version": "string",
              "isDraft": true,
              "isScreeningTask": true,
              "parentId": "string",
              "project": {},
              "projectId": "string",
              "organizationSprint": {},
              "organizationSprintId": "string",
              "taskStatus": {},
              "taskStatusId": "string",
              "taskSize": {},
              "taskSizeId": "string",
              "taskPriority": {},
              "taskPriorityId": "string",
              "taskType": {
                "deletedAt": "2018-11-21T06:20:32.232Z",
                "createdAt": "2018-11-21T06:20:32.232Z",
                "updatedAt": "2018-11-21T06:20:32.232Z",
                "id": "string",
                "isActive": true,
                "isArchived": false,
                "archivedAt": "2018-11-21T06:20:32.232Z",
                "tenantId": "string",
                "organizationId": "string",
                "name": "string",
                "value": "string",
                "description": "string",
                "icon": "string",
                "color": "string",
                "isDefault": false,
                "isSystem": false,
                "imageId": "string",
                "projectId": "string",
                "organizationTeamId": "string"
              },
              "taskTypeId": "string",
              "tags": [
                []
              ],
              "members": [
                []
              ],
              "teams": [
                []
              ],
              "modules": [
                []
              ]
            },
            "taskId": "string",
            "employee": {
              "deletedAt": "2018-11-21T06:20:32.232Z",
              "createdAt": "2018-11-21T06:20:32.232Z",
              "updatedAt": "2018-11-21T06:20:32.232Z",
              "id": "string",
              "isActive": true,
              "isArchived": false,
              "archivedAt": "2018-11-21T06:20:32.232Z",
              "tenantId": "string",
              "organizationId": "string",
              "short_description": "string",
              "description": "string",
              "startedWorkOn": "2024-01-15T09:30:00Z",
              "endWork": "2024-01-15T09:30:00Z",
              "payPeriod": "WEEKLY",
              "billRateValue": 0,
              "minimumBillingRate": 0,
              "billRateCurrency": "USD",
              "reWeeklyLimit": 0,
              "offerDate": "2024-01-15T09:30:00Z",
              "acceptDate": "2024-01-15T09:30:00Z",
              "rejectDate": "2024-01-15T09:30:00Z",
              "employeeLevel": "string",
              "anonymousBonus": true,
              "averageIncome": 0,
              "averageBonus": 0,
              "totalWorkHours": 0,
              "averageExpenses": 0,
              "show_anonymous_bonus": true,
              "show_average_bonus": true,
              "show_average_expenses": true,
              "show_average_income": true,
              "show_billrate": true,
              "show_payperiod": true,
              "show_start_work_on": true,
              "isJobSearchActive": true,
              "linkedInUrl": "string",
              "facebookUrl": "string",
              "instagramUrl": "string",
              "twitterUrl": "string",
              "githubUrl": "string",
              "gitlabUrl": "string",
              "upworkUrl": "string",
              "stackoverflowUrl": "string",
              "isVerified": true,
              "isVetted": true,
              "totalJobs": 0,
              "jobSuccess": 0,
              "profile_link": "string",
              "isTrackingEnabled": true,
              "isOnline": true,
              "isAway": false,
              "isTrackingTime": true,
              "allowScreenshotCapture": true,
              "allowManualTime": true,
              "allowModifyTime": true,
              "allowDeleteTime": true,
              "allowAgentAppExit": true,
              "allowLogoutFromAgentApp": true,
              "trackKeyboardMouseActivity": true,
              "trackAllDisplays": true,
              "upworkId": "string",
              "linkedInId": "string",
              "userId": "string",
              "contactId": "string",
              "organizationPositionId": "string"
            },
            "employeeId": "string",
            "project": {
              "deletedAt": "2018-11-21T06:20:32.232Z",
              "createdAt": "2018-11-21T06:20:32.232Z",
              "updatedAt": "2018-11-21T06:20:32.232Z",
              "id": "string",
              "isActive": true,
              "isArchived": false,
              "archivedAt": "2018-11-21T06:20:32.232Z",
              "tenantId": "string",
              "organizationId": "string",
              "name": "string",
              "startDate": "string",
              "endDate": "string",
              "billing": "FLAT_FEE",
              "currency": "USD",
              "public": true,
              "owner": "CLIENT",
              "taskListType": "GRID",
              "code": "string",
              "description": "string",
              "color": "string",
              "billable": true,
              "billingFlat": true,
              "openSource": true,
              "projectUrl": "string",
              "openSourceProjectUrl": "string",
              "budget": 0,
              "budgetType": "hours",
              "imageUrl": "string",
              "icon": "string",
              "status": "open",
              "isTasksAutoSync": true,
              "isTasksAutoSyncOnLabel": true,
              "syncTag": "string",
              "archiveTasksIn": 0,
              "closeTasksIn": 0,
              "organizationContactId": "string",
              "imageId": "string",
              "defaultAssigneeId": "string"
            },
            "projectId": "string",
            "productId": "string"
          }
        ],
        "tags": [],
        "gallery": []
      }
    ],
    "equipmentImage": [
      {
        "deletedAt": "2018-11-21T06:20:32.232Z",
        "createdAt": "2018-11-21T06:20:32.232Z",
        "updatedAt": "2018-11-21T06:20:32.232Z",
        "id": "string",
        "isActive": true,
        "isArchived": false,
        "archivedAt": "2018-11-21T06:20:32.232Z",
        "tenantId": "string",
        "organizationId": "string",
        "name": "string",
        "type": "string",
        "serialNumber": "string",
        "manufacturedYear": 0,
        "initialCost": 0,
        "currency": "AFN",
        "maxSharePeriod": 0,
        "autoApproveShare": true,
        "equipmentSharings": [
          {
            "deletedAt": "2018-11-21T06:20:32.232Z",
            "createdAt": "2018-11-21T06:20:32.232Z",
            "updatedAt": "2018-11-21T06:20:32.232Z",
            "id": "string",
            "isActive": true,
            "isArchived": false,
            "archivedAt": "2018-11-21T06:20:32.232Z",
            "tenantId": "string",
            "organizationId": "string",
            "name": "string",
            "shareRequestDay": "2024-01-15T09:30:00Z",
            "shareStartDay": "2024-01-15T09:30:00Z",
            "shareEndDay": "2024-01-15T09:30:00Z",
            "status": 0,
            "equipmentId": "string",
            "equipmentSharingPolicy": {
              "deletedAt": "2018-11-21T06:20:32.232Z",
              "createdAt": "2018-11-21T06:20:32.232Z",
              "updatedAt": "2018-11-21T06:20:32.232Z",
              "id": "string",
              "isActive": true,
              "isArchived": false,
              "archivedAt": "2018-11-21T06:20:32.232Z",
              "tenantId": "string",
              "organizationId": "string",
              "name": "string",
              "description": "string"
            },
            "equipmentSharingPolicyId": "string"
          }
        ],
        "tags": []
      }
    ],
    "warehouses": [],
    "productGallery": []
  },
  "logoId": "string",
  "tags": [
    {
      "deletedAt": "2018-11-21T06:20:32.232Z",
      "createdAt": "2018-11-21T06:20:32.232Z",
      "updatedAt": "2018-11-21T06:20:32.232Z",
      "id": "string",
      "isActive": true,
      "isArchived": false,
      "archivedAt": "2018-11-21T06:20:32.232Z",
      "tenantId": "string",
      "organizationId": "string",
      "name": "string",
      "color": "string",
      "textColor": "string",
      "description": "string",
      "icon": "string",
      "isSystem": false,
      "tagTypeId": "string",
      "organizationTeamId": "string"
    }
  ],
  "warehouses": [
    {
      "deletedAt": "2018-11-21T06:20:32.232Z",
      "createdAt": "2018-11-21T06:20:32.232Z",
      "updatedAt": "2018-11-21T06:20:32.232Z",
      "id": "string",
      "isActive": true,
      "isArchived": false,
      "archivedAt": "2018-11-21T06:20:32.232Z",
      "tenantId": "string",
      "organizationId": "string",
      "name": "string",
      "code": "string",
      "email": "string",
      "description": "string",
      "active": true,
      "logo": {},
      "logoId": "string",
      "contactId": "string",
      "products": [
        {
          "deletedAt": "2018-11-21T06:20:32.232Z",
          "createdAt": "2018-11-21T06:20:32.232Z",
          "updatedAt": "2018-11-21T06:20:32.232Z",
          "id": "string",
          "isActive": true,
          "isArchived": false,
          "archivedAt": "2018-11-21T06:20:32.232Z",
          "tenantId": "string",
          "organizationId": "string",
          "quantity": 0,
          "warehouseId": "string",
          "product": {},
          "productId": "string",
          "variants": [
            {
              "deletedAt": "2018-11-21T06:20:32.232Z",
              "createdAt": "2018-11-21T06:20:32.232Z",
              "updatedAt": "2018-11-21T06:20:32.232Z",
              "id": "string",
              "isActive": true,
              "isArchived": false,
              "archivedAt": "2018-11-21T06:20:32.232Z",
              "tenantId": "string",
              "organizationId": "string",
              "quantity": 0,
              "variant": {},
              "variantId": "string",
              "warehouseProductId": "string"
            }
          ]
        }
      ]
    }
  ]
}

Parameters

relationsArray<string>query

idstringrequiredpath

Response

200OKMerchant

Found merchant.

Response fields application/json

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

codestringrequired

emailstringrequired

phonestringrequired

descriptionstringrequired

activeboolean

currencystringrequired

contactContactrequired

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

firstNamestringrequired

lastNamestringrequired

countrystringrequired

citystringrequired

addressstringrequired

address2stringrequired

postcodestring

latitudenumber

longitudenumber

regionCodestringrequired

faxstring

fiscalInformationstring

websitestring

contactIdstringrequired

logoImageAssetrequired

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestring

urlstringrequired

thumbstringrequired

widthnumber0

heightnumber0

sizenumber

isFeaturedbooleanrequired

externalProviderIdstring

storageProviderstringLOCALS3WASABICLOUDINARYDIGITALOCEAN

productFeaturedImageArray<Product>required

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

enabledboolean

codestringrequired

imageUrlstring

featuredImageImageAssetrequired

Same fields as logo

featuredImageIdstringrequired

productTypeProductTyperequired

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

iconstringbriefcase-outlinecar-outlinecolor-palette-outlineflash-outlinehome-outlinegift-outlineheart-outlineradio-button-off-outlinepin-outlinesettings-outlinestar-outlineshopping-bag-outlineshare-outlineactivity-outlinealert-triangle-outlinebulb-outlinecheckmark-circle-outlineglobe-2-outlinelayers-outlinephone-outlineshopping-cart-outlinerequired

productsArray<Product>required

Same fields as logo.productFeaturedImage

translationsArray<ProductTypeTranslation>required

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

descriptionstringrequired

languageCodestringrequired

referenceProductTyperequired

Same fields as logo.productFeaturedImage.productType

referenceIdstringrequired

productTypeIdstringrequired

productCategoryProductCategoryrequired

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

imageUrlstring

imageIdstring

productsArray<Product>required

Same fields as logo.productFeaturedImage

translationsArray<ProductCategoryTranslation>required

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

descriptionstringrequired

languageCodestringrequired

referenceProductCategoryrequired

Same fields as logo.productFeaturedImage.productCategory

referenceIdstringrequired

productCategoryIdstringrequired

translationsArray<ProductTranslation>required

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

descriptionstringrequired

languageCodestringenbgherufreszhdeptitnlplarrequired

referenceProductrequired

Same fields as logo.productFeaturedImage

referenceIdstringrequired

variantsArray<ProductVariant>

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

taxesnumberrequired

notesstring

quantitynumberrequired

billingInvoicingPolicystringrequired

internalReferencestringrequired

enabledboolean

productProductrequired

Same fields as logo.productFeaturedImage

productIdstringrequired

imageImageAssetrequired

Same fields as logo

imageIdstringrequired

warehouseProductVariantsArray<WarehouseProductVariant>required

Same fields as warehouses.products.variants

optionsProductOptionrequired

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

codestringrequired

groupProductOptionGroup

Same fields as logo.productFeaturedImage.optionGroups

groupIdstring

translationsArray<ProductOptionTranslation>required

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

descriptionstringrequired

languageCodestringenbgherufreszhdeptitnlplarrequired

referenceProductOptionrequired

Same fields as logo.productFeaturedImage.variants.options

referenceIdstringrequired

optionGroupsArray<ProductOptionGroup>

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

productProductrequired

Same fields as logo.productFeaturedImage

productIdstringrequired

optionsArray<ProductOption>required

Same fields as logo.productFeaturedImage.variants.options

translationsArray<ProductOptionGroupTranslation>required

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

languageCodestringenbgherufreszhdeptitnlplarrequired

referenceProductOptionGrouprequired

Same fields as logo.productFeaturedImage.optionGroups

referenceIdstringrequired

invoiceItemsArray<InvoiceItem>

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

descriptionstringrequired

pricenumberrequired

quantitynumberrequired

totalValuenumberrequired

applyTaxboolean

applyDiscountboolean

expenseExpense

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

amountnumberrequired

typeOfExpensestring

notesstring

currencystringAFNAFAALLALKDZDADPAOAAOKAONAORARAARSARMARPARLAMDAWGAUDATSAZNAZMBSDBHDBDTBBDBYNBYBBYRBEFBECBELBZDBMDBTNBOBBOLBOVBOPBAMBADBANBWPBRCBRZBREBRRBRNBRBBRLGBPBNDBGLBGNBGOBGMBUKBIFXPFKHRCADCVEKYDXAFCLECLPCLFCNXCNYCOPCOUKMFCDFCRCHRDHRKCUCCUPCYPCZKCSKDKKDJFDOPNLGXCDDDMECSECVEGPGQEERNEEKETBEURXEUFKPFJDFIMFRFXFOXFUGMDGEKGELDEMGHSGHCGIPGRDGTQGWPGNFGNSGYDHTGHNLHKDHUFISKISJINRIDRIRRIQDIEPILSILPILRITLJMDJPYJODKZTKESKWDKGSLAKLVLLVRLBPLSLLRDLYDLTLLTTLULLUCLUFMOPMKDMKNMGAMGFMWKMYRMVRMVPMLFMTLMTPMROMURMXVMXNMXPMDCMDLMCFMNTMADMAFMZEMZNMZMMMKNADNPRANGTWDNZDNIONICNGNKPWNOKOMRPKRPABPGKPYGPEIPENPESPHPPLNPLZPTEGWEQARXRERHDRONROLRUBRURRWFSVCWSTSARRSDCSDSCRSLLSGDSKKSITSBDSOSZARZALKRHKRWKROSSPSURESPESAESBLKRSHPSDDSDGSDPSRDSRGSZLSEKCHFSYPSTDTJRTJSTZSTHBTPETOPTTDTNDTRYTRLTMTTMMUSDUSNUSSUGXUGSUAHUAKAEDUYUUYPUYIUZSVUVVEFVEBVNDVNNCHECHWXOFYDDYERYUNYUDYUMYURZRNZRZZMWZMKZWDZWRZWLrequired

valueDatestring<date-time>

purposestring

taxTypestring

taxLabelstring

rateValuenumberrequired

receiptstring

splitExpensebooleanrequired

referencestring

statusstringINVOICEDUNINVOICEDPAIDNOT_BILLABLE

employeeEmployeerequired

Same fields as logo.productFeaturedImage.invoiceItems.employee

employeeIdstringrequiredread only

vendorOrganizationVendorrequired

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

emailstringrequired

phonestringrequired

websitestringrequired

expensesArray<Expense>

Same fields as logo.productFeaturedImage.invoiceItems.expense

tagsArray<Tag>

Same fields as tags

vendorIdstringrequiredread only

categoryExpenseCategoryrequired

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

expensesArray<Expense>

Same fields as logo.productFeaturedImage.invoiceItems.expense

tagsArray<Tag>

Same fields as tags

categoryIdstringrequiredread only

projectOrganizationProjectrequired

Same fields as logo.productFeaturedImage.invoiceItems.project

projectIdstring

organizationContactOrganizationContactrequired

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

primaryEmailstring

primaryPhonestring

inviteStatusstringNOT_INVITEDINVITEDACCEPTED

notesstring

contactTypestringCLIENTCUSTOMERLEAD

imageUrlstring

budgetnumber

budgetTypestring

contactContactrequired

Same fields as contact

contactIdstring

imageIdstring

projectsArray<OrganizationProject>

Same fields as logo.productFeaturedImage.invoiceItems.project

invoicesArray<Invoice>

Same fields as logo.productFeaturedImage.invoiceItems.invoice

paymentsArray<Payment>

Same fields as logo.productFeaturedImage.invoiceItems.invoice.payments

expensesArray<Expense>

Same fields as logo.productFeaturedImage.invoiceItems.expense

incomesArray<Income>

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

amountnumberrequired

valueDatestring<date-time>

notesstring

isBonusbooleanrequired

referencestring

employeeEmployeerequired

Same fields as logo.productFeaturedImage.invoiceItems.employee

employeeIdstringrequiredread only

clientschemas

Same fields as logo.productFeaturedImage.invoiceItems.invoice.fromOrganization

clientIdstringrequired

tagsArray<schemas>required

Same fields as logo.productFeaturedImage.invoiceItems.invoice.fromOrganization

timeLogsArray<TimeLog>

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

startedAttimestamptzrequired

stoppedAttimestamptzrequired

logTypestringTRACKEDMANUALIDLERESUMEDTRACKEDrequired

sourcestringMOBILEBROWSERDESKTOPBROWSER_EXTENSIONHUBSTAFFUPWORKTEAMSCLOCBROWSERrequired

descriptionstring

reasonstring

isBillablebooleanfalse

isRunningboolean

versionstring

Example

1.0.1

employeeIdstringrequired

timesheetIdstring

projectIdstring

taskIdstring

organizationContactIdstring

organizationTeamIdstring

organizationContactIdstring

invoiceItemsArray<InvoiceItem>

Same fields as logo.productFeaturedImage.invoiceItems

tagsArray<Tag>required

Same fields as tags

expenseIdstring

invoiceInvoice

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

invoiceDatestring<date-time>required

invoiceNumbernumberrequired

dueDatestring<date-time>required

discountValuenumberrequired

paidbooleanrequired

taxnumberrequired

tax2numberrequired

termsstring

totalValuenumber

statusstring

isEstimateboolean

isAcceptedboolean

discountTypestringPERCENTFLATrequired

taxTypestringPERCENTFLATrequired

tax2TypestringPERCENTFLATrequired

invoiceTypestringBY_EMPLOYEE_HOURSBY_PROJECT_HOURSBY_TASK_HOURSBY_PRODUCTSBY_EXPENSESDETAILED_ITEMS

sentTostring

organizationContactIdstring

internalNotestring

alreadyPaidnumber

amountDuenumber

hasRemainingAmountInvoicedboolean

tokenstring

fromOrganizationschemas

Show child attributes

selectobject

relationsobject

whereobjectrequired

orderobject

withDeletedboolean

takenumber[0, 100]

skipnumber>= 0

fromOrganizationIdstringrequired

toContactschemas

Same fields as logo.productFeaturedImage.invoiceItems.invoice.fromOrganization

toContactIdstringrequired

invoiceItemsArray<InvoiceItem>

Same fields as logo.productFeaturedImage.invoiceItems

paymentsArray<Payment>

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

paymentDatestring<date-time>

amountnumberrequired

notestring

paymentMethodstringBANK_TRANSFERCASHCHEQUECREDIT_CARDDEBITONLINE

overdueboolean

employeeIdstringrequired

invoiceInvoice

Same fields as logo.productFeaturedImage.invoiceItems.invoice

invoiceIdstring

projectOrganizationProject

Same fields as logo.productFeaturedImage.invoiceItems.project

projectIdstring

organizationContactOrganizationContact

Same fields as logo.productFeaturedImage.invoiceItems.expense.organizationContact

organizationContactIdstring

tagsArray<array>

historyRecordsArray<InvoiceEstimateHistory>

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

actionstringrequired

titlestring

userUserrequired

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

thirdPartyIdstring

firstNamestring

lastNamestring

emailstring

phoneNumberstring

usernamestring

timeZonestring

timeFormatstring1224

hashstring

refreshTokenstring

imageUrlstring

preferredLanguagestringenbgherufreszhdeptitnlplar

preferredComponentLayoutstringCARDS_GRIDTABLE

uiPreferencesobject

codestring

codeExpireAtstring<date-time>

emailVerifiedAtstring<date-time>

lastLoginAtstring<date-time>

emailTokenstring

roleIdstring

imageIdstring

defaultTeamIdstring

lastTeamIdstring

defaultOrganizationIdstring

lastOrganizationIdstring

userIdstringrequired

invoiceInvoicerequired

Same fields as logo.productFeaturedImage.invoiceItems.invoice

invoiceIdstringrequired

tagsTagrequired

Same fields as tags

invoiceIdstring

taskTask

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

titlestringrequired

descriptionstring

statusstringrequired

prioritystring

sizestring

issueTypestring

estimatenumber

dueDatestring<date-time>

publicboolean

startDatestring<date-time>

resolvedAtstring<date-time>

versionstring

isDraftboolean

isScreeningTaskboolean

parentTask

Same fields as logo.productFeaturedImage.invoiceItems.task

parentIdstring

projectobject

projectIdstring

organizationSprintobject

organizationSprintIdstring

taskStatusobject

taskStatusIdstring

taskSizeobject

taskSizeIdstring

taskPriorityobject

taskPriorityIdstring

taskTypeIssueType

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

valuestringrequired

descriptionstring

iconstring

colorstring

isDefaultbooleanfalse

isSystembooleanfalse

imageIdstring

projectIdstring

organizationTeamIdstring

taskTypeIdstring

tagsArray<array>

membersArray<array>

teamsArray<array>

modulesArray<array>

taskIdstring

employeeEmployee

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

short_descriptionstring

descriptionstring

startedWorkOnstring<date-time>

endWorkstring<date-time>

payPeriodstringNONEBI_WEEKLYWEEKLYTWICE_PER_MONTHMONTHLY

Example

WEEKLY

billRateValuenumber

minimumBillingRatenumber

billRateCurrencystringAFNAFAALLALKDZDADPAOAAOKAONAORARAARSARMARPARLAMDAWGAUDATSAZNAZMBSDBHDBDTBBDBYNBYBBYRBEFBECBELBZDBMDBTNBOBBOLBOVBOPBAMBADBANBWPBRCBRZBREBRRBRNBRBBRLGBPBNDBGLBGNBGOBGMBUKBIFXPFKHRCADCVEKYDXAFCLECLPCLFCNXCNYCOPCOUKMFCDFCRCHRDHRKCUCCUPCYPCZKCSKDKKDJFDOPNLGXCDDDMECSECVEGPGQEERNEEKETBEURXEUFKPFJDFIMFRFXFOXFUGMDGEKGELDEMGHSGHCGIPGRDGTQGWPGNFGNSGYDHTGHNLHKDHUFISKISJINRIDRIRRIQDIEPILSILPILRITLJMDJPYJODKZTKESKWDKGSLAKLVLLVRLBPLSLLRDLYDLTLLTTLULLUCLUFMOPMKDMKNMGAMGFMWKMYRMVRMVPMLFMTLMTPMROMURMXVMXNMXPMDCMDLMCFMNTMADMAFMZEMZNMZMMMKNADNPRANGTWDNZDNIONICNGNKPWNOKOMRPKRPABPGKPYGPEIPENPESPHPPLNPLZPTEGWEQARXRERHDRONROLRUBRURRWFSVCWSTSARRSDCSDSCRSLLSGDSKKSITSBDSOSZARZALKRHKRWKROSSPSURESPESAESBLKRSHPSDDSDGSDPSRDSRGSZLSEKCHFSYPSTDTJRTJSTZSTHBTPETOPTTDTNDTRYTRLTMTTMMUSDUSNUSSUGXUGSUAHUAKAEDUYUUYPUYIUZSVUVVEFVEBVNDVNNCHECHWXOFYDDYERYUNYUDYUMYURZRNZRZZMWZMKZWDZWRZWL

Example

USD

reWeeklyLimitnumber

offerDatestring<date-time>

acceptDatestring<date-time>

rejectDatestring<date-time>

employeeLevelstring

anonymousBonusboolean

averageIncomenumberrequired

averageBonusnumberrequired

totalWorkHoursnumberrequired

averageExpensesnumberrequired

show_anonymous_bonusboolean

show_average_bonusboolean

show_average_expensesboolean

show_average_incomeboolean

show_billrateboolean

show_payperiodboolean

show_start_work_onboolean

isJobSearchActiveboolean

linkedInUrlstring

facebookUrlstring

instagramUrlstring

twitterUrlstring

githubUrlstring

gitlabUrlstring

upworkUrlstring

stackoverflowUrlstring

isVerifiedboolean

isVettedboolean

totalJobsnumberrequired

jobSuccessnumberrequired

profile_linkstring

isTrackingEnabledboolean

isOnlineboolean

isAwaystringfalse

isTrackingTimeboolean

allowScreenshotCaptureboolean

allowManualTimeboolean

allowModifyTimeboolean

allowDeleteTimeboolean

allowAgentAppExitboolean

allowLogoutFromAgentAppboolean

trackKeyboardMouseActivityboolean

trackAllDisplaysboolean

upworkIdstring

linkedInIdstring

userIdstringrequired

contactIdstringrequired

organizationPositionIdstringrequired

employeeIdstring

projectOrganizationProject

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

startDatestring

endDatestring

billingstringRATEFLAT_FEEMILESTONES

Example

FLAT_FEE

Example

USD

publicboolean

ownerstringCLIENTINTERNAL

Example

CLIENT

taskListTypestringGRIDSPRINTrequired

Example

GRID

codestring

descriptionstring

colorstring

billableboolean

billingFlatboolean

openSourceboolean

projectUrlstring

openSourceProjectUrlstring

budgetnumber

budgetTypestringhourscost

imageUrlstring

iconstring

statusstringopenin-progresscompletedcancelledcustomopen

isTasksAutoSyncboolean

isTasksAutoSyncOnLabelboolean

syncTagstring

archiveTasksInnumber

closeTasksInnumber

organizationContactIdstring

imageIdstring

defaultAssigneeIdstring

projectIdstring

productProduct

Same fields as logo.productFeaturedImage

productIdstring

warehousesArray<WarehouseProduct>

Same fields as warehouses.products

tagsArray<Tag>required

Same fields as tags

galleryArray<ImageAsset>required

Same fields as logo

equipmentImageArray<Equipment>required

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

typestringrequired

serialNumberstring

manufacturedYearnumberrequired

initialCostnumberrequired

maxSharePeriodnumberrequired

autoApproveSharebooleanrequired

imageImageAssetrequired

Same fields as logo

equipmentSharingsArray<EquipmentSharing>required

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestring

shareRequestDaystring<date-time>

shareStartDaystring<date-time>

shareEndDaystring<date-time>

statusnumberrequired

equipmentEquipment

Same fields as logo.equipmentImage

equipmentIdstring

equipmentSharingPolicyEquipmentSharingPolicy

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

descriptionstring

equipmentSharingPolicyIdstring

tagsArray<Tag>required

Same fields as tags

warehousesArray<Warehouse>required

Same fields as warehouses

productGalleryArray<Product>required

Same fields as logo.productFeaturedImage

logoIdstringrequired

tagsArray<Tag>required

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

colorstringrequired

textColorstring

descriptionstring

iconstring

isSystembooleanfalse

tagTypeIdstring

organizationTeamIdstring

warehousesArray<Warehouse>required

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

codestringrequired

emailstringrequired

descriptionstringrequired

activeboolean

logoImageAssetrequired

Same fields as logo

logoIdstringrequired

contactIdstringrequired

productsArray<WarehouseProduct>required

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

quantitynumber

warehouseWarehouserequired

Same fields as warehouses

warehouseIdstringrequired

productProductrequired

Same fields as logo.productFeaturedImage

productIdstringrequired

variantsArray<WarehouseProductVariant>required

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

quantitynumber

variantProductVariantrequired

Same fields as logo.productFeaturedImage.variants

variantIdstringrequired

warehouseProductIdstringrequired

401Unauthorized

Unauthorized

403Forbidden

Forbidden

404Not Found

Record not found

Authorization

bearerhttp (bearer) in header

Enter JWT token

Stack Overflow Website Demo