1. Immigration
  • Overview
  • Endpoints
    • Companies
      • All companies
      • Get a company
      • Create company
      • Create payment
    • Pricing
      • Get pricing packages
    • Countries
      • All countries
      • Get a country
    • Forms
      • Get a form
    • Leads
      • All leads
      • Get a lead
      • Update status
    • Profile
      • Get profile
      • Update profile
    • Wallet
      • Get wallet balance
      • Create topup request
    • Support
      • All tickets
      • Get a ticket
      • Create a ticket
    • Notifications
      • All notifications
      • Mark as read
      • Pusher auth
    • Renewals
      • Search companies for renewal
      • Get dynamic form config for a jurisdiction
      • List renewal requests
      • Request a quote revision
      • Approve quote and confirm wallet payment
      • Initiate quote payment — send OTP
      • Get a renewal by ID
      • Submit a renewal request
    • Files
      • Get a one-time download URL for any file owned by the agent
    • Immigration
      • List immigration objectives
        GET
      • Submit an assessment and get matching programmes
        POST
      • Get application pre-fill
        GET
      • Create an application (draft or submitted)
        POST
      • List applications
        GET
      • Get an application
        GET
      • Update a draft (save again or submit)
        PATCH
      • Delete a draft
        DELETE
  • Schemas
    • QuoteConfig
    • CreatePaymentSuccessResponse
    • SuccessEnvelope
    • StandardSuccess
    • ErrorEnvelope
    • ErrorResponse
    • FieldValidation
    • DirectApplication
    • YesNo
    • FileAttachment
    • Company
    • QuoteBreakdown
    • Field
    • Objective
    • Quote
    • Section
    • AssessmentRequest
    • RenewalFormConfigBody
    • ProcessingStep
    • ProgrammeSummary
    • CreateCompanyRequest
    • ProgrammeMatch
    • RenewalFormConfig
    • CompletedDetails
    • ExternalCompany
    • ApplicationPrefill
    • Renewal
    • Applicant
    • FormConfigField
    • ApplicantFields
    • FormConfigSection
    • FamilyMember
    • FamilyMemberFields
    • FormConfig
    • Funds
    • DocumentMeta
    • Declarations
    • StoredDeclarations
    • ApplicationRequest
    • ApplicationStatus
    • Application
    • ApplicationDetail
    • CountryRef
    • CountryName
    • ApplicationListItem
  1. Immigration

List immigration objectives

Testing Env
https://demoapi.base93.com/api/v1/user/external/agent/
Testing Env
https://demoapi.base93.com/api/v1/user/external/agent/
GET
https://demoapi.base93.com/api/v1/user/external/agent/
immigration/objectives
Active objectives, ordered for display. Use their _ids in the assessment's objectives array.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://demoapi.base93.com/api/v1/user/external/agent/immigration/objectives' \
--header 'Authorization: Bearer <token>'

Responses

🟢200
application/json
Objectives
Bodyapplication/json

Example
{
    "status": true,
    "response_code": 200,
    "data": {
        "objectives": [
            {
                "_id": "66f1a2b3c4d5e6f708192a3b",
                "code": "SECOND_PASSPORT",
                "name": "Second Passport",
                "description": "Obtain an additional citizenship",
                "icon": "passport",
                "status": "ACTIVE",
                "sort_order": 1,
                "created_at": "2026-09-01T10:00:00.000Z",
                "updated_at": "2026-09-01T10:00:00.000Z"
            }
        ]
    }
}
🟠401Unauthorized
🟠403Forbidden
Modified at 2026-10-08 12:48:36
Previous
Get a one-time download URL for any file owned by the agent
Next
Submit an assessment and get matching programmes
Built with